campaign_costs_get_list
Retrieve campaign cost data by specifying tenant ID, year, month, and optional filters like page size or sorting. Includes total count if needed for detailed analysis.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| campaignId | No | Format - int64. Campaign ID | |
| includeTotal | No | Whether total count should be returned | |
| month | No | Format - int32. Month | |
| page | No | Format - int32. The logical number of page to return, starting from 1 | |
| pageSize | No | Format - int32. How many records to return (50 by default) | |
| sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, Date (Year + Month) | |
| tenant | Yes | Format - int64. Tenant ID | |
| year | No | Format - int32. Year |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"campaignId": {
"description": "Format - int64. Campaign ID",
"type": "integer"
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": "boolean"
},
"month": {
"description": "Format - int32. Month",
"type": "integer"
},
"page": {
"description": "Format - int32. The logical number of page to return, starting from 1",
"type": "integer"
},
"pageSize": {
"description": "Format - int32. How many records to return (50 by default)",
"type": "integer"
},
"sort": {
"description": "Applies sorting by the specified field:\n\"?sort=+FieldName\" for ascending order,\n\"?sort=-FieldName\" for descending order.\n\nAvailable fields are: Id, Date (Year + Month)",
"type": "string"
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
},
"year": {
"description": "Format - int32. Year",
"type": "integer"
}
},
"required": [
"tenant"
],
"type": "object"
}