Playground Status

Aggregate generation_job state per lead for the optional batch_id.

GET /api/v1/campaigns/{campaign_id}/playground/status

Playground Status

cURL

curl --request GET \
  --url https://api.example.com/api/v1/campaigns/{campaign_id}/playground/status \
  --header 'Authorization: Bearer <token>'

200

{
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "overall": {},
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "per_lead": [
    {
      "campaign_lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "<string>",
      "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "error": "<string>",
      "completed_at": "2023-11-07T05:31:56Z",
      "has_draft": false,
      "subject_preview": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaign_id · string<uuid> · required

Query Parameters

batch_id · string<uuid> | null

Filter to a specific batch (optional).

Response

200

application/json

Successful Response

Overall + per-lead batch progress. Returned by GET /playground/status.

campaign_id · string<uuid> · required

overall · Overall · object · required

Show child attributes

batch_id · string<uuid> | null

per_lead · PlaygroundGenerationJobState · object[]

Show child attributes