Post v1audiencecontactsreport

POST /v1/audience/contacts/report

cURL

cURL

curl --request POST \
  --url https://api.comm.com/api/v1/audience/contacts/report \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "sortModel": [
    {
      "sort": "asc",
      "colId": "updated_datetime"
    }
  ],
  "filterModel": "{\"is_sent\":{\"filterType\":\"number\",\"type\":\"greaterThan\",\"filter\":5}}\n\nnote that it needs to be col_id: {FilterModel}, PHP doesn't support this kind of description.",
  "rowGroupCols": [
    {
      "id": "campaign_id",
      "displayName": "Campaign_Id",
      "field": "campaign_id"
    }
  ],
  "groupKeys": "[\"campaign_uuid\"]\nNot the column type, it's a filter of the query",
  "startRow": 1,
  "endRow": 2,
  "selectCols": [],
  "groupByAll": true
}
EOF

200

{
  "data": "<string>",
  "meta": {
    "current_page": "<string>",
    "last_page": "<string>",
    "per_page": "<string>",
    "total": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

sortModel · tuple

Example:

[
  {
    "sort": "asc",
    "colId": "updated_datetime"
  }
]

filterModel · tuple

Show child attributes

Example:

"{\"is_sent\":{\"filterType\":\"number\",\"type\":\"greaterThan\",\"filter\":5}}\n\nnote that it needs to be col_id: {FilterModel}, PHP doesn't support this kind of description."

rowGroupCols · tuple

Example:

[
  {
    "id": "campaign_id",
    "displayName": "Campaign_Id",
    "field": "campaign_id"
  }
]

groupKeys · tuple

Show child attributes

Example:

"[\"campaign_uuid\"]\nNot the column type, it's a filter of the query"

startRow · integer

Required range: x >= 0

endRow · integer

Required range: x >= 1

selectCols · tuple

groupByAll · boolean

Response

200

application/json

data · string · required

meta · object · required

Show child attributes