Developers
Reports12

List exam performance

GET/reports/exams

Returns aggregate performance metrics for each exam. Use product_id to limit the report to a single product.

This report does not include individual answers or user names.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

product_id?string

Only exams of the product with this public ID.

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/reports/exams"
{  "data": [    {      "object": "report_row",      "report": "string"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Ignore an email bounce PATCH

Marks an email bounce as ignored so the user's address can receive email from the account again. Requires the `email_bounces.ignore` permission. The only accepted value is `ignored: true`. This change cannot be reverted through the API. To make the update conditional, send an `If-Match` header built from the bounce's `revision` field, in the format `W/"email_bounce:<bounce_id>:<revision>"`. If the bounce has changed since that revision, the update is rejected.

Retrieve export metrics GET

Returns aggregate export metrics for the account, including totals by status and the most recent exports. To page through all exports, use the exports collection endpoint, which requires the `exports.read` permission.