performance_get
Retrieve segmented performance data for campaigns, ad groups, or keywords within a specified time range using tenant ID, date filters, and pagination options.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fromUtc | Yes | Format - date-time (as date-time in RFC3339). Gets or sets the start date and time in UTC for the filtering period. | |
| includeTotal | No | Whether total count should be returned | |
| 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) | |
| performanceSegmentationType | Yes | Gets or sets the type of performance segmentation for filtering purposes. | |
| tenant | Yes | Format - int64. Tenant ID | |
| toUtc | Yes | Format - date-time (as date-time in RFC3339). Gets or sets the end date and time in UTC for the filtering period. |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"fromUtc": {
"description": "Format - date-time (as date-time in RFC3339). Gets or sets the start date and time in UTC for the filtering period.",
"format": "date-time",
"type": "string"
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": "boolean"
},
"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"
},
"performanceSegmentationType": {
"description": "Gets or sets the type of performance segmentation for filtering purposes.",
"enum": [
"Campaign",
"AdGroup",
"Keyword"
],
"type": "string"
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
},
"toUtc": {
"description": "Format - date-time (as date-time in RFC3339). Gets or sets the end date and time in UTC for the filtering period.",
"format": "date-time",
"type": "string"
}
},
"required": [
"tenant",
"fromUtc",
"toUtc",
"performanceSegmentationType"
],
"type": "object"
}