Skip to content
CognizyCognizyHelp
Sign in
In this area

Campaigns

Read campaigns and their analytics.

List campaigns

get/v1/public/campaigns

Paginated list of campaigns in the organization. Filter by status or channel. Returns data (with template name) + meta.{total,page,limit,totalPages}.

Parameters

limitnumberoptional· query
Range 1–100
pagenumberoptional· query
channelWEB_CHAT | WHATSAPP | EMAIL | INSTAGRAM | MESSENGER | APIoptional· query
statusDRAFT | SCHEDULED | RUNNING | COMPLETED | CANCELLEDoptional· query

Responses

  • 200

Examples

bash
curl -X GET "https://api.cognizy.ai/api/v1/public/campaigns" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Get a campaign

get/v1/public/campaigns/{id}

Returns the campaign with template, segment, handoff department, and all the denormalized counters (sent, replied, opened, etc).

Parameters

idstringrequired· path
Campaign ID

Responses

  • 200Campaign returned
  • 404Campaign not found

Examples

bash
curl -X GET "https://api.cognizy.ai/api/v1/public/campaigns/<id>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Get campaign analytics

get/v1/public/campaigns/{id}/analytics

Returns totals (sent, failed, replied, qualified, booked, opted-out, email deliverability) plus a bucketed time series of conversations spawned by this campaign. Use for A/B test analysis and engagement over time.

Parameters

idstringrequired· path
Campaign ID
granularityhour | day | weekoptional· query
Default day

Responses

  • 200Campaign analytics returned
  • 404Campaign not found

Examples

bash
curl -X GET "https://api.cognizy.ai/api/v1/public/campaigns/<id>/analytics" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Full reference