Progress and stats

GEThttps://server.heyrik.com/api/v1/campaigns/{id}

Path parameters

idRequired

Replace {id} in the request URL with the value for this resource.

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Response

Explore the example values. This is not a complete response schema.

dataobject

Explore 5 properties

idstring

Example "cmp_4a19"

statusstring

Example "running"

totalnumber

Example 250

countsobject

Explore 3 properties

pendingnumber

Example 132

completednumber

Example 108

failednumber

Example 10

category_countsobject

Explore 3 properties

hotnumber

Example 40

warmnumber

Example 55

coldnumber

Example 13

Error reference

GET/campaigns/{id}

cURL

curl https://server.heyrik.com/api/v1/campaigns/cmp_4a19 \
  -H "Authorization: Bearer $HEYRIK_API_KEY"

Response example

JSON

{
  "data": {
    "id": "cmp_4a19",
    "status": "running",
    "total": 250,
    "counts": { "pending": 132, "completed": 108, "failed": 10 },
    "category_counts": { "hot": 40, "warm": 55, "cold": 13 }
  }
}

Illustrative examples · No live request is sent