Post v1audiencecompaniesbalancesummary

POST /v1/audience/companies/balance/summary

cURL

cURL

curl --request POST \
  --url https://api.comm.com/api/v1/audience/companies/balance/summary \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "endRow": 2,
  "sortModel": [
    {
      "sort": "asc",
      "colId": "log_date"
    }
  ],
  "filterModel": {
    "campaign_name": {
      "filterType": "text",
      "type": "contains",
      "filter": "multi"
    }
  },
  "rowGroupCols": [
    {
      "id": "campaign_name",
      "displayName": "Campaign_name",
      "field": "campaign_name"
    }
  ],
  "groupKeys": [
    "<string>"
  ],
  "startRow": 1,
  "groupByAll": true
}
'

200

{
  "data": [
    {
      "id": "<string>",
      "client_routing_company_id": "<string>",
      "amount": "<string>",
      "balance_type": "<string>",
      "meta": "<string>",
      "date_created": "<string>"
    }
  ],
  "meta": {
    "total": 123
  }
}

Authorizations

Authorization · string · header · required

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

Body

application/json

endRow · integer · required

Required range: x >= 1

sortModel · tuple

Show child attributes

Example:

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

filterModel · tuple

Show child attributes

Example:

{
  "campaign_name": {
    "filterType": "text",
    "type": "contains",
    "filter": "multi"
  }
}

rowGroupCols · tuple

Show child attributes

Example:

[
  {
    "id": "campaign_name",
    "displayName": "Campaign_name",
    "field": "campaign_name"
  }
]

groupKeys · string[]

startRow · integer

Required range: x >= 0

groupByAll · boolean

Response

200

application/json

data · DataGridRouteCompanyBalanceResource · object[] · required

Show child attributes

meta · object · required

Show child attributes