CIcint
Reconciliations

List target groups eligible for reconciliation

List all target groups within the account that have sessions eligible for reconciliation within the current month by default. The API can return a list of target groups with sessions expiring next month by including 'next_month' in the query parameter.

get/demand/accounts/{account_id}/reconciliations/eligible-target-groups

Request

Path parameters

account_idinteger required

The account's unique identifier.

Example:101

Query parameters

page_sizeinteger

A limit on the number of objects to be returned, between 1 and 100.

start_afterstring

Returns a list of objects after the provided pagination cursor, using the next_cursor from the previous response.

due_month'current_month' | 'next_month'
Example:current_month

Due month. Can be either 'current_month' or 'next_month'. Defaults to 'current_month' if not provided.

namestring

Filter by target group name

statusstring

Filter by target group status

project_namestring

Filter by project name

project_manager_idstring

Filter by project manager ID

Response

Successfully returned list of target groups.

urlstring

URL related to the request

has_moreboolean

Indicates if there are more pages of results

next_cursorstring

Cursor for pagination. This field is optional and may be omitted if there are no more pages.

page_sizeinteger

Number of items per page

Example response

{
  "target_groups": [
    {
      "last_reconciliation_date": "2023-01-01T23:00:00.000Z",
      "monetary_amount": {
        "value": "2.7352",
        "currency_code": "USD",
        "currency_scale": 2
      }
    }
  ],
  "url": "/accounts/1/reconciliations/eligible-target-groups",
  "summary": {
    "monetary_amount": {
      "value": "2.7352",
      "currency_code": "USD",
      "currency_scale": 2
    },
    "completes": "100",
    "target_group_count": "123"
  },
  "has_more": true,
  "next_cursor": "01JBVVGBWXTC06F0J0W18CBE9R",
  "page_size": 10
}

Changes

No recorded changes to this operation across all 1 revision of this API.