Skip to main content
POST
GetAttributionRollups

Authorizations

Authorization
string
header
required

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

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

GetAttributionRollupsRequest specifies how to group settled spend.

dimension
enum<string>

Dimension used to group settled calls.

Available options:
ATTRIBUTION_DIMENSION_UNSPECIFIED,
ATTRIBUTION_DIMENSION_USER,
ATTRIBUTION_DIMENSION_DEPARTMENT,
ATTRIBUTION_DIMENSION_AGENT,
ATTRIBUTION_DIMENSION_SESSION,
ATTRIBUTION_DIMENSION_MODEL,
ATTRIBUTION_DIMENSION_CALL_SOURCE,
ATTRIBUTION_DIMENSION_SUBJECT_FUND_SOURCE,
ATTRIBUTION_DIMENSION_APP
endTime
string<date-time> | null
filters
Attribution Filters · object | null

AttributionFilters narrows settled usage before grouping. All predicates are exact matches and combine with AND; values within one list combine with OR.

pageSize
integer<int32>

Maximum number of groups to return. The default is 25 and the maximum is 100.

pageToken
string

Pagination token from a previous response with the same window, dimension, and filters.

startTime
string<date-time> | null

Response

200 - application/json

GetAttributionRollupsResponse contains one page of ranked attribution groups.

GetAttributionRollupsResponse contains one page of ranked attribution groups.

groups
Attribution Group · object[] | null

Groups ordered by settled spend descending, then key ascending.

nextPageToken
string

Token for the next page. Empty when no more groups remain.