Reports

The analyses people build over their call data, readable as data.

A report is a document (sections, tables, charts) built in the product over an organization's own call data. This surface reads them, so a report someone assembled by hand can be pulled into a warehouse, a dashboard or a scheduled email without being rebuilt there.

The list carries metadata only; content is fetched a report at a time, because listing twenty with their content would be megabytes for a page that shows titles. The conversation that produced a report is not served. It is the questions someone asked along the way, not the answer they published. Nor is the query behind each section or block: it is how the platform refreshes the numbers, not part of the report.

Reading a report through the API does not count as a view: view counts are about people looking at a report, not integrations polling one.

List reports#

Reports in the key's organization that the key may read, newest first. Metadata only. A page can hold fewer rows than `pageSize` when some on it are not readable; follow `nextCursor` rather than counting rows.

GET/api/v1/reports

Query parameters

searchstring: Match the title.
pagenumber: Page number.; Default1
pageSizenumber: Up to 100.; Default20

Responses

A page of reports.

Request

curl -X GET "https://voice.evryhealth.com/api/v1/reports" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response200

{
  "data": {
    "reports": [
      {
        "id": "6b22…",
        "title": "September refill outcomes",
        "reportType": "campaign",
        "status": "complete",
        "tags": [
          "refills"
        ],
        "campaignIds": [
          "a1…"
        ],
        "viewCount": 12
      }
    ],
    "total": 7
  },
  "meta": {
    "requestId": "req_…",
    "pagination": {
      "nextCursor": null,
      "limit": 20
    }
  }
}

Get a report#

One report, with its content.

GET/api/v1/reports/{reportId}

Path parameters

reportIdstringrequired: Report id.

Responses

The report.

Request

curl -X GET "https://voice.evryhealth.com/api/v1/reports/{reportId}" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response200

{
  "data": {
    "id": "6b22…",
    "title": "September refill outcomes",
    "status": "complete",
    "content": {
      "sections": [
        {
          "type": "text",
          "title": "Summary"
        }
      ]
    }
  },
  "meta": {
    "requestId": "req_…"
  }
}

Delete a report#

Removes the report.

DELETE/api/v1/reports/{reportId}

Path parameters

reportIdstringrequired: Report id.

Responses

Deleted.

Request

curl -X DELETE "https://voice.evryhealth.com/api/v1/reports/{reportId}" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response200

{
  "data": {
    "deleted": true
  },
  "meta": {
    "requestId": "req_…"
  }
}