POST
/
v1
/
segments
/
progress
cURL
curl --request POST \
  --url https://api.comm.com/api/v1/segments/progress \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filter_segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "with_dashboards": true,
  "audience_feed_ids": [
    "<string>"
  ],
  "voice_campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segment_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}'
{
  "contacts_left": 123,
  "contacts_total": 123,
  "views": [
    {
      "type": "card",
      "target_id": "<string>",
      "source_id": "<string>"
    }
  ],
  "debug": "<string>"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
filter_segment_id
string<uuid> | null
with_dashboards
boolean
audience_feed_ids
string[]
voice_campaign_id
string<uuid> | null
segment_ids
string<uuid>[]

Response

contacts_left
integer
required
contacts_total
integer
required
views
MetabaseData · object[]
required
debug
string
required