/v2/publishers/{publisherId}/reports/spa/ad-groups
GET
https://<pcm-domain>/v2/publishers/{publisherId}/reports/spa/ad-groups
Path Parameters
- publisherIdinteger<int32>requiredFormatint32
Query Parameters
- orderBystringrequiredAllowedADVERTISER_IDADVERTISER_NAMEAD_GROUP_IDAD_GROUP_NAMEDATE
- sortTypestringAllowedASCDESC
- publisherIdinteger<int32>Formatint32
- dateBreakdownbooleanDescription
- startAtstring<date>requiredDescriptionFormatdate
- endAtstring<date>requiredDescriptionFormatdate
- pageinteger<int32>requiredFormatint32Minimum0Maximum1000
- limitinteger<int32>requiredFormatint32Minimum100Maximum10000
Responses
200
- ExternalV2PublisherAdGroupReport
- detailedV2PublisherSpaAdGroupReportRow[]
- impressionsinteger<int64>Formatint64
- clicksinteger<int64>Formatint64
- conversionsinteger<int64>Formatint64
- unitsSoldinteger<int64>Formatint64
- clickThroughRatenumber<double>Formatdouble
- conversionRatenumber<double>Formatdouble
- conversionValuenumber<double>Formatdouble
- costPerClicknumber<double>Formatdouble
- returnOnAdSpendnumber<double>Formatdouble
- adSpendRevenuenumber<double>Formatdouble
- loadsinteger<int64>Formatint64
- advertiserIdstring
- advertiserNamestring
- adGroupIdstring
- adGroupNamestring
- datestring
- aggregatedAggregatedV2SpaReportRow
- countinteger<int64>Formatint64
- metricsV2SpaReportRow
- impressionsinteger<int64>Formatint64
- clicksinteger<int64>Formatint64
- conversionsinteger<int64>Formatint64
- unitsSoldinteger<int64>Formatint64
- clickThroughRatenumber<double>Formatdouble
- conversionRatenumber<double>Formatdouble
- conversionValuenumber<double>Formatdouble
- costPerClicknumber<double>Formatdouble
- returnOnAdSpendnumber<double>Formatdouble
- adSpendRevenuenumber<double>Formatdouble
- loadsinteger<int64>Formatint64
401
403
404
- ExceptionResponse
- messagesstring[]
curl
curl --request GET \
--url 'https://<pcm-domain>/v2/publishers/{publisherId}/reports/spa/ad-groups?orderBy=ADVERTISER_ID&startAt=string%3Cdate%3E&endAt=string%3Cdate%3E&page=integer%3Cint32%3E&limit=integer%3Cint32%3E' \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://<pcm-domain>/v2/publishers/{publisherId}/reports/spa/ad-groups?orderBy=ADVERTISER_ID&startAt=string<date>&endAt=string<date>&page=integer<int32>&limit=integer<int32>", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://<pcm-domain>/v2/publishers/{publisherId}/reports/spa/ad-groups?orderBy=ADVERTISER_ID&startAt=string<date>&endAt=string<date>&page=integer<int32>&limit=integer<int32>")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://<pcm-domain>/v2/publishers/{publisherId}/reports/spa/ad-groups?orderBy=ADVERTISER_ID&startAt=string<date>&endAt=string<date>&page=integer<int32>&limit=integer<int32>"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// OK
{
"detailed": [
{
"impressions": "",
"clicks": "",
"conversions": "",
"unitsSold": "",
"clickThroughRate": "",
"conversionRate": "",
"conversionValue": "",
"costPerClick": "",
"returnOnAdSpend": "",
"adSpendRevenue": "",
"loads": "",
"advertiserId": "",
"advertiserName": "",
"adGroupId": "",
"adGroupName": "",
"date": ""
}
],
"aggregated": {
"count": "",
"metrics": {
"impressions": "",
"clicks": "",
"conversions": "",
"unitsSold": "",
"clickThroughRate": "",
"conversionRate": "",
"conversionValue": "",
"costPerClick": "",
"returnOnAdSpend": "",
"adSpendRevenue": "",
"loads": ""
}
}
}401
// Unauthorized
403
// Forbidden
404
// Not Found
{
"messages": [
""
]
}