Skip to content
DashboardGet API key

Get campaign progress

View .md
GET

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • campaignIdstringrequired

    Campaign ID. The same ID works as broadcastId on /v1.

Responses

200Progress.
  • statusstringrequired

    Current status of the campaign. pending_review: in the automated content review. pending_admin_review: the automated review passed and it waits for a person, which is where every channel but a WhatsApp campaign on an approved template goes. rejected: the review refused it; edit it and send again, or escalate. scheduled and sending follow approval.

    One ofdraftpending_reviewpending_admin_reviewapprovedrejectedescalatedrejected_finalscheduledsendingpausedcompletedcancelledfailed
  • totalintegerrequired

    Total contacts in broadcast.

  • pendingintegerrequired

    Not yet queued for sending.

  • sendingintegerrequired

    Currently being sent.

  • sentinteger

    Accepted by the provider, delivery not confirmed yet.

  • deliveredintegerrequired

    Confirmed delivered to the device.

  • failedintegerrequired

    Failed to deliver.

  • skippedintegerrequired

    Skipped (broadcast cancelled).

  • percentCompletenumberrequired

    Percentage complete (0-100).

  • estimatedCostnumbernullable

    Estimated total cost in USD.

  • reservedAmountnumbernullable

    Amount reserved from balance in USD.

  • actualCostnumbernullable

    Actual cost so far in USD.

  • startedAtstring<date-time>
  • estimatedCompletionAtstring<date-time>
  • campaignIdstringrequired
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject

    Machine-readable context. Keys that mean the same thing everywhere: - errors: present on every 400 invalid_request for an invalid body or query parameter, [{path, message, ...}], path naming the field (["to"], ["contacts", 2, "recipient"], ["limit"]). - recommendation: one sentence saying what to do next. - dashboardUrl: the dashboard screen that fixes it. - connect: on 409 no_channel, the channels this project can connect to reach the recipient, each {type, request, note, available, dashboardUrl?}; request is the exact call (POST /v2/channels with its body, or POST /v2/numbers), or null for a channel connected from the dashboard (WhatsApp, Instagram, Messenger). available: false says why in note (one-way SMS closed until business verification is approved). - address / from: the address the error is about, under the name the request used for it.

    1 properties
    • errorsobject[]
      3 properties
      • pathobject[]required
      • messagestringrequired
      • codestring
404Campaign not found, or it belongs to another project.
  • codestringrequired
  • messagestringrequired
  • detailsobject

    Machine-readable context. Keys that mean the same thing everywhere: - errors: present on every 400 invalid_request for an invalid body or query parameter, [{path, message, ...}], path naming the field (["to"], ["contacts", 2, "recipient"], ["limit"]). - recommendation: one sentence saying what to do next. - dashboardUrl: the dashboard screen that fixes it. - connect: on 409 no_channel, the channels this project can connect to reach the recipient, each {type, request, note, available, dashboardUrl?}; request is the exact call (POST /v2/channels with its body, or POST /v2/numbers), or null for a channel connected from the dashboard (WhatsApp, Instagram, Messenger). available: false says why in note (one-way SMS closed until business verification is approved). - address / from: the address the error is about, under the name the request used for it.

    1 properties
    • errorsobject[]
      3 properties
      • pathobject[]required
      • messagestringrequired
      • codestring