Competitor Tracker & Co. Docs
Dispatches

List send and open events for a dispatch, newest-first.

Every send and open recorded for one dispatch, newest-first. Each entry names the recipient, what happened and when it happened. A send that did not get through is here too, with a short reason. Opens also say whether the reader looked like a person or an automated one. This is a log, not a report: there are no totals and no rates here.

Required role: member or higher (organization-level).

Required scope: dispatches:read (for both OAuth2 tokens and API keys).

GET
/v1/dispatches/{id}/engagement

Authorization

X-API-Key<token>

In: header

Path Parameters

id*string
Length1 <= length

Query Parameters

cursor?string
Length1 <= length
limit?integer
Range1 <= value <= 100

Response Body

application/json

application/json

application/json

curl -X GET "https://api.competitortracker.io/v1/dispatches/01J0000000000000000000000/engagement"
{
  "items": [
    {
      "id": "string",
      "recipientEmail": "string",
      "event": "delivered",
      "openedBy": "person",
      "error": "string",
      "occurredAt": "string"
    }
  ],
  "nextCursor": "string"
}
{
  "code": "string",
  "message": "string",
  "resolution": "string"
}
{
  "code": "string",
  "message": "string",
  "resolution": "string"
}

List a notification's email delivery attempts, newest-first. GET

List a notification's email delivery attempts, newest-first — Competitor Tracker & Co. API reference for GET /v1/dispatches/{id}/deliveries: request parameters.

Org

Organization-lifecycle operations: leave, transfer ownership, delete — the REST API reference for this group: every path with its parameters, the request body.