API Docs

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.

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 the key can reach, newest first. Metadata only.

GET/api/v1/reports

Query parameters

ParameterTypeDescription
search
string

Match the title.

page
number

Page number.

Default: 1

pageSize
number

Up to 100.

Default: 20

Responses

{
  "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
    }
  }
}
Request
curl -X GET "https://voice.evryhealth.com/api/v1/reports" \
  -H "Authorization: Bearer YOUR_API_KEY"

Get a report

One report, with its content.

GET/api/v1/reports/{reportId}

Path parameters

ParameterTypeDescription
reportIdrequired
string

Report id.

Responses

{
  "data": {
    "id": "6b22…",
    "title": "September refill outcomes",
    "status": "complete",
    "content": {
      "sections": [
        {
          "type": "text",
          "title": "Summary"
        }
      ]
    }
  },
  "meta": {
    "requestId": "req_…"
  }
}
Request
curl -X GET "https://voice.evryhealth.com/api/v1/reports/{reportId}" \
  -H "Authorization: Bearer YOUR_API_KEY"

Delete a report

Removes the report.

DELETE/api/v1/reports/{reportId}

Path parameters

ParameterTypeDescription
reportIdrequired
string

Report id.

Responses

{
  "data": {
    "deleted": true
  },
  "meta": {
    "requestId": "req_…"
  }
}
Request
curl -X DELETE "https://voice.evryhealth.com/api/v1/reports/{reportId}" \
  -H "Authorization: Bearer YOUR_API_KEY"