Enrichment API - Analytics Reports v2.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
The purpose of this API is to provide the ability for Pixalate Analytics subscribers to ingest analytics data and metadata into their own internal systems.
Please contact your Customer Success Manager for Analytics API access
Base URLs:
Email: Pixalate, Inc. Web: Pixalate, Inc.
Authentication
- API Key (ApiKey)
- Parameter Name: x-api-key, in: header.
Authentication and authorization is achieved by supplying your Pixalate provided API key in the header of the request. An API key may be obtained by signing up for an account on the Pixalate developer website.
As of April 2023, Pixalate supports an API-key based authentication method for the Analytics Report API. If you have been provided with username and password credentials during your onboarding to access the Report API, please visit our documentation here to get started. If you have been provided with an API key, the documentation on this page will guide you on how to integrate.
- Parameter Name: x-api-key, in: header.
Analytics Reports
Get Analytics Reports Metadata
Code samples
# You can also use wget
curl -X GET https://api.pixalate.com/api/v2/analytics/reports \
-H 'Accept: application/json' \
-H 'x-api-key: API_KEY'
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://api.pixalate.com/api/v2/analytics/reports";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"x-api-key": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.pixalate.com/api/v2/analytics/reports", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const headers = {
'Accept':'application/json',
'x-api-key':'API_KEY'
};
fetch('https://api.pixalate.com/api/v2/analytics/reports',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-api-key':'API_KEY'
};
fetch('https://api.pixalate.com/api/v2/analytics/reports',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'x-api-key': 'API_KEY'
}
r = requests.get('https://api.pixalate.com/api/v2/analytics/reports', headers = headers)
print(r.json())
GET /analytics/reports
The purpose of this API is to provide metadata information for analytics reports in general. The response is a JSON formatted object containing the current user's quota state and the date the analytics reports database was last updated.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| pretty | query | boolean | false | If true, return pretty JSON. Default is false. |
Example responses
200 Response
{
"database": {
"lastUpdated": "2022-04-30"
},
"quota": {
"available": 480,
"used": 520,
"expiry": "2022-05-01T12:45:23.234Z",
"limit": 1000,
"interval": 1000,
"timeUnit": "month"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Metadata |
| 400 | Bad Request | Bad Request - Invalid parameters in request. | None |
| 401 | Unauthorized | Unauthorized - Invalid API Key. | None |
| 403 | Forbidden | Forbidden - Rate plan expired or quota has been exhausted. | None |
| 5XX | Unknown | Server Error - The API experienced an internal error. Contact support. | None |
Get Analytics Report
Code samples
# You can also use wget
curl -X GET https://api.pixalate.com/api/v2/analytics/reports/{reportId} \
-H 'Accept: application/json' \
-H 'x-api-key: API_KEY'
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
private HttpClient Client { get; set; }
/// <<summary>>
/// Setup http client
/// <</summary>>
public HttpExample()
{
Client = new HttpClient();
}
/// Make a dummy request
public async Task MakeGetRequest()
{
string url = "https://api.pixalate.com/api/v2/analytics/reports/{reportId}";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"x-api-key": []string{"API_KEY"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.pixalate.com/api/v2/analytics/reports/{reportId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
const headers = {
'Accept':'application/json',
'x-api-key':'API_KEY'
};
fetch('https://api.pixalate.com/api/v2/analytics/reports/{reportId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
const fetch = require('node-fetch');
const headers = {
'Accept':'application/json',
'x-api-key':'API_KEY'
};
fetch('https://api.pixalate.com/api/v2/analytics/reports/{reportId}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/json',
'x-api-key': 'API_KEY'
}
r = requests.get('https://api.pixalate.com/api/v2/analytics/reports/{reportId}', headers = headers)
print(r.json())
GET /analytics/reports/{reportId}
The purpose of this API is to provide the ability for Pixalate Analytics subscribers to ingest analytics data into their own internal systems. The response is a JSON formatted object containing a list of report items.
Parameters
| Name | In | Type | Required | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| reportId | path | string | true | The report's unique identifier. To request the default analytics report, use the term default as the report identifier. |
||||||||||||||||||||
| timeZone | query | integer | false | The time zone in which to sync the report data. The timezone is the number of minutes from GMT. Default is 0. | ||||||||||||||||||||
| start | query | integer | false | Which item in the results from which to start. | ||||||||||||||||||||
| limit | query | integer | false | The total number of items to return. Default is 20. | ||||||||||||||||||||
| q | query | string | false | A URL encoded query to run to retrieve data. It uses a simplified SQL SELECT syntax as follows: [ column [ Note: All characters and their values are case sensitive.
|
||||||||||||||||||||
| exportUrl | query | boolean | false | Setting this flag to true indicates that the API returns a URI to the CSV data as an Internet resource rather than the data itself. While the resulting resource is public, the URI contains a randomly generated identifier that ensures the data is relatively secure unless the URI itself is made public by the user. | ||||||||||||||||||||
| isAsync | query | boolean | false | If set to true, a CSV URI response is returned immediately. However, this will return a 404 Not Found HTTP status code until the service completes processing the report. Note that this parameter is only recognized when the exportUri parameter is also supplied as true. Note also that the limit parameter is ignored when this parameter is set to true. | ||||||||||||||||||||
| isLargeResultSet | query | boolean | false | If set to true, then processing is handled identically as if the isAsync parameter is set to true. However, the returned CSV file contains a single column with each row being a URL to a CSV file that contains part of the data. Large results that set ORDER BY may cause an 400 Bad Request HTTP status code. To resolve, try removing the ORDER BY clause. Note that this parameter is only recognized when the exportUri parameter is also supplied as true. Note also that the limit parameter is ignored when this parameter is set to true. | ||||||||||||||||||||
| pretty | query | boolean | false | If true, return pretty JSON. Default is false. |
Example responses
200 Response
{
"numFound": 1,
"docs": [
{
"adDomain": "example.org",
"adSize": "320x50",
"adTrafficSource": "Discovery",
"advertiserId": "1263B",
"areaCode": "650",
"browserName": "AppleWebKit",
"campaignId": "160529",
"city": "Macon",
"countryCode": "US",
"countryName": "UnitedStates",
"day": "2023-01-16",
"deviceBrandName": "Apple",
"deviceModelId": "AppleIphonev",
"deviceMarketingName": "AppleIphone",
"deviceTrafficType": "app",
"deviceType": "mobile",
"dma": "503",
"fraudType": "maskedIp",
"ipv6Type": "6to4",
"kv1": "320x50",
"kv2": "https://www.example.com/2322222/example.html",
"kv3": "74b724ec10",
"kv4": "192.168.1.0",
"kv5": "U.S. Dept. of Commerce - NOAA - NMFS",
"kv6": "IAB19-29",
"kv7": 5,
"kv8": "example_ex2",
"kv9": "45.0",
"kv10": "AT&T Wireless",
"kv12": "78768/6177",
"kv13": "8907892376",
"kv14": "1,2",
"kv15": "OMAHA",
"kv16": "65.0",
"kv17": "-147.5",
"kv18": "1523297725",
"kv19": "e499",
"kv20": "2279d822",
"kv21": "9dffe499822227",
"kv22": "9dff87e499",
"kv23": "iPhone:Apple",
"kv24": "Mobile_InApp_Video",
"kv25": "Example Player",
"kv26": "iPhone OS",
"kv27": "Mozilla/5.0 (Linux; Android 7.1.2; AFTMM Build/NS6295; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/106.0.5249.170 Mobile Safari/537.36",
"kv28": "Apple_iPhone SE",
"kv32": "637671",
"kv44": null,
"kv52": null,
"kv55": "1.0,1!example.com,219,1,c1554a1301!example2.com,3290857094",
"lineItemId": "23",
"organization": "ComcastCable",
"os": "MacOSX(iPhone)",
"partnerId": "examp",
"placementId": "872093903",
"postalCode": "101773",
"publisherId": "examplemedia",
"regionCode": "11",
"segment": "5778,2374",
"siteId": "7714",
"adultRisk": "medium",
"drugRisk": "medium",
"alcoholRisk": "medium",
"advisoriesRisk": "medium",
"hateRisk": "medium",
"offensiveRisk": "medium",
"gamblingRisk": "medium",
"violenceRisk": "medium",
"impressions": 107638742,
"shareOfImpressions": 1,
"ssaiImpressions": 3552420,
"ssaiImpressionsRate": 0.33,
"ssaiTransparentImpressions": 1333924,
"ssaiTransparentImpressionsRate": 0.01239,
"ipv6Impressions": 38132536,
"ipv6ImpressionsRate": 0.35426,
"duplicateImps": 4644646,
"duplicateImpsRate": 0.04315,
"nonGivtImpressions": 106485383,
"shareOfNonGivtImpressions": 1,
"nonGivtSsaiImpressions": 3469267,
"nonGivtSsaiImpressionsRate": 0.03258,
"nonGivtSsaiTransparentImpressions": 1325682,
"nonGivtSsaiTransparentImpressionsRate": 0.01245,
"nonGivtIpv6Impressions": 38075513,
"nonGivtIpv6ImpressionsRate": 0.35757,
"nonGivtDuplicateImps": 4314329,
"nonGivtDuplicateImpsRate": 0.04052,
"nonGivtSivtImpressions": 99896454,
"shareOfNonGivtSivtImpressions": 1,
"nonGivtSivtSsaiImpressions": 2761628,
"nonGivtSivtSsaiImpressionsRate": 0.02764,
"nonGivtSivtSsaiTransparentImpressions": 1182730,
"nonGivtSivtSsaiTransparentImpressionsRate": 0.01184,
"nonGivtSivtIpv6Impressions": 35873185,
"nonGivtSivtIpv6ImpressionsRate": 0.3591,
"nonGivtSivtDuplicateImps": 3668854,
"nonGivtSivtDuplicateImpsRate": 0.03673,
"givtImpressions": 1153359,
"givtImpsRate": 0.01072,
"shareOfGivtImpressions": 1,
"givtIpv6Impressions": 57023,
"givtIpv6ImpressionsRate": 0.00053,
"sivtImpressions": 6588929,
"sivtImpsRate": 0.06121,
"shareOfSivtImpressions": 1,
"shareOfGivtSivtImpressions": 1,
"sivtIpv6Impressions": 2202328,
"sivtIpv6ImpressionsRate": 0.02046,
"givtSivtIpv6Impressions": 2259351,
"givtSivtIpv6ImpressionsRate": 0.02099
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | ItemList |
| 400 | Bad Request | Bad Request - Invalid parameters in request. | None |
| 401 | Unauthorized | Unauthorized - Invalid API Key. | None |
| 403 | Forbidden | Forbidden - Rate plan expired or quota has been exhausted. | None |
| 5XX | Unknown | Server Error - The API experienced an internal error. Contact support. | None |
Schemas
Metadata
{
"database": {
"lastUpdated": "2022-04-30"
},
"quota": {
"available": 480,
"used": 520,
"expiry": "2022-05-01T12:45:23.234Z",
"limit": 1000,
"interval": 1000,
"timeUnit": "month"
}
}
Analytics Reports metadata information.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| database | object | false | none | Analytics Reports database state information. |
| » lastUpdated | string(date) | false | none | The date when the Analytics Reports database was last updated. The date format is YYYY-MM-DD. |
| quota | object | false | none | Quota state information. |
| » available | integer | false | none | The amount of quota available for use. |
| » used | integer | false | none | The amount of quota used. |
| » expiry | string(date) | false | none | The datetime when the quota will be refreshed back to the limit. The datetime format is YYYY-MM-DDTHH:MM:SS.SSSZ. |
| » limit | integer | false | none | The amount of quota to be made available for use when the quota is refreshed. |
| » interval | integer | false | none | The number of time units used in calculating the quota refresh datetime. |
| » timeUnit | string | false | none | The time unit used in calculating the quota refresh datetime. |
Enumerated Values
| Property | Value |
|---|---|
| timeUnit | minute |
| timeUnit | hour |
| timeUnit | day |
| timeUnit | week |
| timeUnit | month |
ItemList
{
"numFound": 1,
"docs": [
{
"adDomain": "example.org",
"adSize": "320x50",
"adTrafficSource": "Discovery",
"advertiserId": "1263B",
"areaCode": "650",
"browserName": "AppleWebKit",
"campaignId": "160529",
"city": "Macon",
"countryCode": "US",
"countryName": "UnitedStates",
"day": "2023-01-16",
"deviceBrandName": "Apple",
"deviceModelId": "AppleIphonev",
"deviceMarketingName": "AppleIphone",
"deviceTrafficType": "app",
"deviceType": "mobile",
"dma": "503",
"fraudType": "maskedIp",
"ipv6Type": "6to4",
"kv1": "320x50",
"kv2": "https://www.example.com/2322222/example.html",
"kv3": "74b724ec10",
"kv4": "192.168.1.0",
"kv5": "U.S. Dept. of Commerce - NOAA - NMFS",
"kv6": "IAB19-29",
"kv7": 5,
"kv8": "example_ex2",
"kv9": "45.0",
"kv10": "AT&T Wireless",
"kv12": "78768/6177",
"kv13": "8907892376",
"kv14": "1,2",
"kv15": "OMAHA",
"kv16": "65.0",
"kv17": "-147.5",
"kv18": "1523297725",
"kv19": "e499",
"kv20": "2279d822",
"kv21": "9dffe499822227",
"kv22": "9dff87e499",
"kv23": "iPhone:Apple",
"kv24": "Mobile_InApp_Video",
"kv25": "Example Player",
"kv26": "iPhone OS",
"kv27": "Mozilla/5.0 (Linux; Android 7.1.2; AFTMM Build/NS6295; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/106.0.5249.170 Mobile Safari/537.36",
"kv28": "Apple_iPhone SE",
"kv32": "637671",
"kv44": null,
"kv52": null,
"kv55": "1.0,1!example.com,219,1,c1554a1301!example2.com,3290857094",
"lineItemId": "23",
"organization": "ComcastCable",
"os": "MacOSX(iPhone)",
"partnerId": "examp",
"placementId": "872093903",
"postalCode": "101773",
"publisherId": "examplemedia",
"regionCode": "11",
"segment": "5778,2374",
"siteId": "7714",
"adultRisk": "medium",
"drugRisk": "medium",
"alcoholRisk": "medium",
"advisoriesRisk": "medium",
"hateRisk": "medium",
"offensiveRisk": "medium",
"gamblingRisk": "medium",
"violenceRisk": "medium",
"impressions": 107638742,
"shareOfImpressions": 1,
"ssaiImpressions": 3552420,
"ssaiImpressionsRate": 0.33,
"ssaiTransparentImpressions": 1333924,
"ssaiTransparentImpressionsRate": 0.01239,
"ipv6Impressions": 38132536,
"ipv6ImpressionsRate": 0.35426,
"duplicateImps": 4644646,
"duplicateImpsRate": 0.04315,
"nonGivtImpressions": 106485383,
"shareOfNonGivtImpressions": 1,
"nonGivtSsaiImpressions": 3469267,
"nonGivtSsaiImpressionsRate": 0.03258,
"nonGivtSsaiTransparentImpressions": 1325682,
"nonGivtSsaiTransparentImpressionsRate": 0.01245,
"nonGivtIpv6Impressions": 38075513,
"nonGivtIpv6ImpressionsRate": 0.35757,
"nonGivtDuplicateImps": 4314329,
"nonGivtDuplicateImpsRate": 0.04052,
"nonGivtSivtImpressions": 99896454,
"shareOfNonGivtSivtImpressions": 1,
"nonGivtSivtSsaiImpressions": 2761628,
"nonGivtSivtSsaiImpressionsRate": 0.02764,
"nonGivtSivtSsaiTransparentImpressions": 1182730,
"nonGivtSivtSsaiTransparentImpressionsRate": 0.01184,
"nonGivtSivtIpv6Impressions": 35873185,
"nonGivtSivtIpv6ImpressionsRate": 0.3591,
"nonGivtSivtDuplicateImps": 3668854,
"nonGivtSivtDuplicateImpsRate": 0.03673,
"givtImpressions": 1153359,
"givtImpsRate": 0.01072,
"shareOfGivtImpressions": 1,
"givtIpv6Impressions": 57023,
"givtIpv6ImpressionsRate": 0.00053,
"sivtImpressions": 6588929,
"sivtImpsRate": 0.06121,
"shareOfSivtImpressions": 1,
"shareOfGivtSivtImpressions": 1,
"sivtIpv6Impressions": 2202328,
"sivtIpv6ImpressionsRate": 0.02046,
"givtSivtIpv6Impressions": 2259351,
"givtSivtIpv6ImpressionsRate": 0.02099
}
]
}
A list of report items.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| numFound | integer | false | none | The total number of report items. |
| docs | [Item] | false | none | A list of report items. |
Item
{
"adDomain": "example.org",
"adSize": "320x50",
"adTrafficSource": "Discovery",
"advertiserId": "1263B",
"areaCode": "650",
"browserName": "AppleWebKit",
"campaignId": "160529",
"city": "Macon",
"countryCode": "US",
"countryName": "UnitedStates",
"day": "2023-01-16",
"deviceBrandName": "Apple",
"deviceModelId": "AppleIphonev",
"deviceMarketingName": "AppleIphone",
"deviceTrafficType": "app",
"deviceType": "mobile",
"dma": "503",
"fraudType": "maskedIp",
"ipv6Type": "6to4",
"kv1": "320x50",
"kv2": "https://www.example.com/2322222/example.html",
"kv3": "74b724ec10",
"kv4": "192.168.1.0",
"kv5": "U.S. Dept. of Commerce - NOAA - NMFS",
"kv6": "IAB19-29",
"kv7": 5,
"kv8": "example_ex2",
"kv9": "45.0",
"kv10": "AT&T Wireless",
"kv12": "78768/6177",
"kv13": "8907892376",
"kv14": "1,2",
"kv15": "OMAHA",
"kv16": "65.0",
"kv17": "-147.5",
"kv18": "1523297725",
"kv19": "e499",
"kv20": "2279d822",
"kv21": "9dffe499822227",
"kv22": "9dff87e499",
"kv23": "iPhone:Apple",
"kv24": "Mobile_InApp_Video",
"kv25": "Example Player",
"kv26": "iPhone OS",
"kv27": "Mozilla/5.0 (Linux; Android 7.1.2; AFTMM Build/NS6295; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/106.0.5249.170 Mobile Safari/537.36",
"kv28": "Apple_iPhone SE",
"kv32": "637671",
"kv44": null,
"kv52": null,
"kv55": "1.0,1!example.com,219,1,c1554a1301!example2.com,3290857094",
"lineItemId": "23",
"organization": "ComcastCable",
"os": "MacOSX(iPhone)",
"partnerId": "examp",
"placementId": "872093903",
"postalCode": "101773",
"publisherId": "examplemedia",
"regionCode": "11",
"segment": "5778,2374",
"siteId": "7714",
"adultRisk": "medium",
"drugRisk": "medium",
"alcoholRisk": "medium",
"advisoriesRisk": "medium",
"hateRisk": "medium",
"offensiveRisk": "medium",
"gamblingRisk": "medium",
"violenceRisk": "medium",
"impressions": 107638742,
"shareOfImpressions": 1,
"ssaiImpressions": 3552420,
"ssaiImpressionsRate": 0.33,
"ssaiTransparentImpressions": 1333924,
"ssaiTransparentImpressionsRate": 0.01239,
"ipv6Impressions": 38132536,
"ipv6ImpressionsRate": 0.35426,
"duplicateImps": 4644646,
"duplicateImpsRate": 0.04315,
"nonGivtImpressions": 106485383,
"shareOfNonGivtImpressions": 1,
"nonGivtSsaiImpressions": 3469267,
"nonGivtSsaiImpressionsRate": 0.03258,
"nonGivtSsaiTransparentImpressions": 1325682,
"nonGivtSsaiTransparentImpressionsRate": 0.01245,
"nonGivtIpv6Impressions": 38075513,
"nonGivtIpv6ImpressionsRate": 0.35757,
"nonGivtDuplicateImps": 4314329,
"nonGivtDuplicateImpsRate": 0.04052,
"nonGivtSivtImpressions": 99896454,
"shareOfNonGivtSivtImpressions": 1,
"nonGivtSivtSsaiImpressions": 2761628,
"nonGivtSivtSsaiImpressionsRate": 0.02764,
"nonGivtSivtSsaiTransparentImpressions": 1182730,
"nonGivtSivtSsaiTransparentImpressionsRate": 0.01184,
"nonGivtSivtIpv6Impressions": 35873185,
"nonGivtSivtIpv6ImpressionsRate": 0.3591,
"nonGivtSivtDuplicateImps": 3668854,
"nonGivtSivtDuplicateImpsRate": 0.03673,
"givtImpressions": 1153359,
"givtImpsRate": 0.01072,
"shareOfGivtImpressions": 1,
"givtIpv6Impressions": 57023,
"givtIpv6ImpressionsRate": 0.00053,
"sivtImpressions": 6588929,
"sivtImpsRate": 0.06121,
"shareOfSivtImpressions": 1,
"shareOfGivtSivtImpressions": 1,
"sivtIpv6Impressions": 2202328,
"sivtIpv6ImpressionsRate": 0.02046,
"givtSivtIpv6Impressions": 2259351,
"givtSivtIpv6ImpressionsRate": 0.02099
}
Properties
allOf
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Dimensions | false | none | Dimensions are the attributes of the data that return values listed in rows. For example, the domain dimension indicates the URL and returns each URL value in an individual row. Many of the dimensions available via the API align with the dimensions available in Pixalate's dashboard reporting. Please note that some dimensions (eg. User IP, Device ID, Custom KVs (KV5, KV6), etc.) may not be enabled by default, in which case please reach out to your customer success representative to enable. |
and
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | Metrics | false | none | Metrics report the numbers used for quantitative measurement in relation to the reported attributes of dimension. For example, the impressions metric indicates the total number of impressions for each dimension's given row. Many of the metrics available via the API align with the metrics available in Pixalate's dashboard reporting. |
Dimensions
{
"adDomain": "example.org",
"adSize": "320x50",
"adTrafficSource": "Discovery",
"advertiserId": "1263B",
"areaCode": "650",
"browserName": "AppleWebKit",
"campaignId": "160529",
"city": "Macon",
"countryCode": "US",
"countryName": "UnitedStates",
"day": "2023-01-16",
"deviceBrandName": "Apple",
"deviceModelId": "AppleIphonev",
"deviceMarketingName": "AppleIphone",
"deviceTrafficType": "app",
"deviceType": "mobile",
"dma": "503",
"fraudType": "maskedIp",
"ipv6Type": "6to4",
"kv1": "320x50",
"kv2": "https://www.example.com/2322222/example.html",
"kv3": "74b724ec10",
"kv4": "192.168.1.0",
"kv5": "U.S. Dept. of Commerce - NOAA - NMFS",
"kv6": "IAB19-29",
"kv7": 5,
"kv8": "example_ex2",
"kv9": "45.0",
"kv10": "AT&T Wireless",
"kv12": "78768/6177",
"kv13": "8907892376",
"kv14": "1,2",
"kv15": "OMAHA",
"kv16": "65.0",
"kv17": "-147.5",
"kv18": "1523297725",
"kv19": "e499",
"kv20": "2279d822",
"kv21": "9dffe499822227",
"kv22": "9dff87e499",
"kv23": "iPhone:Apple",
"kv24": "Mobile_InApp_Video",
"kv25": "Example Player",
"kv26": "iPhone OS",
"kv27": "Mozilla/5.0 (Linux; Android 7.1.2; AFTMM Build/NS6295; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/106.0.5249.170 Mobile Safari/537.36",
"kv28": "Apple_iPhone SE",
"kv32": "637671",
"kv44": null,
"kv52": null,
"kv55": "1.0,1!example.com,219,1,c1554a1301!example2.com,3290857094",
"lineItemId": "23",
"organization": "ComcastCable",
"os": "MacOSX(iPhone)",
"partnerId": "examp",
"placementId": "872093903",
"postalCode": "101773",
"publisherId": "examplemedia",
"regionCode": "11",
"segment": "5778,2374",
"siteId": "7714",
"adultRisk": "medium",
"drugRisk": "medium",
"alcoholRisk": "medium",
"advisoriesRisk": "medium",
"hateRisk": "medium",
"offensiveRisk": "medium",
"gamblingRisk": "medium",
"violenceRisk": "medium"
}
Dimensions are the attributes of the data that return values listed in rows. For example, the domain dimension indicates the URL and returns each URL value in an individual row. Many of the dimensions available via the API align with the dimensions available in Pixalate's dashboard reporting.
Please note that some dimensions (eg. User IP, Device ID, Custom KVs (KV5, KV6), etc.) may not be enabled by default, in which case please reach out to your customer success representative to enable.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| adDomain | string | false | none | Detected Domain of site where ad was displayed |
| adSize | string | false | none | Size of the ad |
| adTrafficSource | string | false | none | Domain of which referred visitor to ad domain |
| advertiserId | string | false | none | Advertiser identifier |
| areaCode | string | false | none | Visitor’s area code |
| browserName | string | false | none | Visitor’s browser name |
| campaignId | string | false | none | Campaign identifier |
| city | string | false | none | Visitor’s city |
| countryCode | string | false | none | Visitor’s country code |
| countryName | string | false | none | Visitor’s country name |
| day | string | false | none | Date |
| deviceBrandName | string | false | none | Visitor’s device brand name |
| deviceModelId | string | false | none | Visitor’s device identifier |
| deviceMarketingName | string | false | none | Visitor’s device marketing name |
| deviceTrafficType | string | false | none | Visitor’s Detected device Traffic type |
| deviceType | string | false | none | Visitor’s device type |
| dma | string | false | none | Designated Market Area |
| fraudType | string | false | none | Fraud Traffic Type |
| ipv6Type | string | false | none | IPv6 Type |
| kv1 | string | false | none | Creative Size |
| kv2 | string | false | none | Page URL |
| kv3 | string | false | none | User ID |
| kv4 | string | false | none | User IP (can be IPv4 or IPv6) |
| kv5 | string | false | none | (Custom) |
| kv6 | string | false | none | (Custom UTM Value) |
| kv7 | string | false | none | Seller ID |
| kv8 | string | false | none | (Custom UTM Value) |
| kv9 | string | false | none | Content Duration |
| kv10 | string | false | none | ISP |
| kv12 | string | false | none | Placement ID |
| kv13 | string | false | none | Content ID |
| kv14 | string | false | none | MRAID Version |
| kv15 | string | false | none | Geographic Region |
| kv16 | string | false | none | Latitude |
| kv17 | string | false | none | Longitude |
| kv18 | string | false | none | App ID or Bundle ID |
| kv19 | string | false | none | Device ID |
| kv20 | string | false | none | Device ID (additional if needed) |
| kv21 | string | false | none | Device ID (additional if needed) |
| kv22 | string | false | none | Device ID (additional if needed) |
| kv23 | string | false | none | Carrier ID |
| kv24 | string | false | none | Supply Type |
| kv25 | string | false | none | App Name |
| kv26 | string | false | none | Device OS |
| kv27 | string | false | none | Useragent |
| kv28 | string | false | none | Device manufacturer/model |
| kv32 | string | false | none | App ID |
| kv44 | string | false | none | Video Play Status |
| kv52 | string | false | none | SSAI integration |
| kv55 | string | false | none | Serialized supply chain object |
| lineItemId | string | false | none | Line item identifier |
| organization | string | false | none | Organization Name |
| os | string | false | none | Visitor’s operating system |
| partnerId | string | false | none | Partner identifier |
| placementId | string | false | none | Creative identifier |
| postalCode | string | false | none | Visitor’s postal code |
| publisherId | string | false | none | Publisher identifier |
| regionCode | string | false | none | Visitor’s region code |
| segment | string | false | none | Segment |
| siteId | string | false | none | Site identifier |
| adultRisk | string | false | none | Adult Risk (Brand Safety) |
| drugRisk | string | false | none | Drug Risk (Brand Safety) |
| alcoholRisk | string | false | none | Alcohol Risk (Brand Safety) |
| advisoriesRisk | string | false | none | Advisories Risk (Brand Safety) |
| hateRisk | string | false | none | Hate Risk (Brand Safety) |
| offensiveRisk | string | false | none | Offensive Risk (Brand Safety) |
| gamblingRisk | string | false | none | Gambling Risk (Brand Safety) |
| violenceRisk | string | false | none | Violence Risk (Brand Safety) |
Enumerated Values
| Property | Value |
|---|---|
| adultRisk | low |
| adultRisk | medium |
| adultRisk | high |
| drugRisk | low |
| drugRisk | medium |
| drugRisk | high |
| alcoholRisk | low |
| alcoholRisk | medium |
| alcoholRisk | high |
| advisoriesRisk | low |
| advisoriesRisk | medium |
| advisoriesRisk | high |
| hateRisk | low |
| hateRisk | medium |
| hateRisk | high |
| offensiveRisk | low |
| offensiveRisk | medium |
| offensiveRisk | high |
| gamblingRisk | low |
| gamblingRisk | medium |
| gamblingRisk | high |
| violenceRisk | low |
| violenceRisk | medium |
| violenceRisk | high |
Metrics
{
"impressions": 107638742,
"shareOfImpressions": 1,
"ssaiImpressions": 3552420,
"ssaiImpressionsRate": 0.33,
"ssaiTransparentImpressions": 1333924,
"ssaiTransparentImpressionsRate": 0.01239,
"ipv6Impressions": 38132536,
"ipv6ImpressionsRate": 0.35426,
"duplicateImps": 4644646,
"duplicateImpsRate": 0.04315,
"nonGivtImpressions": 106485383,
"shareOfNonGivtImpressions": 1,
"nonGivtSsaiImpressions": 3469267,
"nonGivtSsaiImpressionsRate": 0.03258,
"nonGivtSsaiTransparentImpressions": 1325682,
"nonGivtSsaiTransparentImpressionsRate": 0.01245,
"nonGivtIpv6Impressions": 38075513,
"nonGivtIpv6ImpressionsRate": 0.35757,
"nonGivtDuplicateImps": 4314329,
"nonGivtDuplicateImpsRate": 0.04052,
"nonGivtSivtImpressions": 99896454,
"shareOfNonGivtSivtImpressions": 1,
"nonGivtSivtSsaiImpressions": 2761628,
"nonGivtSivtSsaiImpressionsRate": 0.02764,
"nonGivtSivtSsaiTransparentImpressions": 1182730,
"nonGivtSivtSsaiTransparentImpressionsRate": 0.01184,
"nonGivtSivtIpv6Impressions": 35873185,
"nonGivtSivtIpv6ImpressionsRate": 0.3591,
"nonGivtSivtDuplicateImps": 3668854,
"nonGivtSivtDuplicateImpsRate": 0.03673,
"givtImpressions": 1153359,
"givtImpsRate": 0.01072,
"shareOfGivtImpressions": 1,
"givtIpv6Impressions": 57023,
"givtIpv6ImpressionsRate": 0.00053,
"sivtImpressions": 6588929,
"sivtImpsRate": 0.06121,
"shareOfSivtImpressions": 1,
"shareOfGivtSivtImpressions": 1,
"sivtIpv6Impressions": 2202328,
"sivtIpv6ImpressionsRate": 0.02046,
"givtSivtIpv6Impressions": 2259351,
"givtSivtIpv6ImpressionsRate": 0.02099
}
Metrics report the numbers used for quantitative measurement in relation to the reported attributes of dimension. For example, the impressions metric indicates the total number of impressions for each dimension's given row. Many of the metrics available via the API align with the metrics available in Pixalate's dashboard reporting.
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| impressions | integer | false | none | Gross Ad Counts |
| shareOfImpressions | number | false | none | Share of Gross Ad Counts % |
| ssaiImpressions | integer | false | none | Gross SSAI Ad Counts |
| ssaiImpressionsRate | number | false | none | Gross SSAI Ad Counts % |
| ssaiTransparentImpressions | integer | false | none | Gross SSAI Transparent Ad Counts |
| ssaiTransparentImpressionsRate | number | false | none | Gross SSAI Transparent Ad Counts % |
| ipv6Impressions | integer | false | none | Gross IPv6 Ad Counts |
| ipv6ImpressionsRate | number | false | none | Gross IPv6 Ad Counts % |
| duplicateImps | integer | false | none | Gross Duplicate Ad Counts |
| duplicateImpsRate | number | false | none | Gross Duplicate Ad Counts % |
| nonGivtImpressions | integer | false | none | Ad Counts |
| shareOfNonGivtImpressions | number | false | none | Share of Ad Counts % |
| nonGivtSsaiImpressions | integer | false | none | SSAI Ad Counts |
| nonGivtSsaiImpressionsRate | number | false | none | SSAI Ad Counts % |
| nonGivtSsaiTransparentImpressions | integer | false | none | SSAI Transparent Ad Counts |
| nonGivtSsaiTransparentImpressionsRate | number | false | none | SSAI Transparent Ad Counts % |
| nonGivtIpv6Impressions | integer | false | none | IPv6 Ad Counts |
| nonGivtIpv6ImpressionsRate | number | false | none | IPv6 Ad Counts % |
| nonGivtDuplicateImps | integer | false | none | Duplicate Ad Counts |
| nonGivtDuplicateImpsRate | number | false | none | Duplicate Ad Counts % |
| nonGivtSivtImpressions | integer | false | none | Net Ad Counts |
| shareOfNonGivtSivtImpressions | number | false | none | Share of Net Ad Counts % |
| nonGivtSivtSsaiImpressions | integer | false | none | Net SSAI Ad Counts |
| nonGivtSivtSsaiImpressionsRate | number | false | none | Net SSAI Ad Counts % |
| nonGivtSivtSsaiTransparentImpressions | integer | false | none | Net SSAI Transparent Ad Counts |
| nonGivtSivtSsaiTransparentImpressionsRate | number | false | none | Net SSAI Transparent Ad Counts % |
| nonGivtSivtIpv6Impressions | integer | false | none | Net IPv6 Ad Counts |
| nonGivtSivtIpv6ImpressionsRate | number | false | none | Net IPv6 Ad Counts % |
| nonGivtSivtDuplicateImps | integer | false | none | Net Duplicate Ad Counts |
| nonGivtSivtDuplicateImpsRate | number | false | none | Net Duplicate Ad Counts % |
| givtImpressions | integer | false | none | GIVT Ad Counts |
| givtImpsRate | number | false | none | GIVT Ad Counts % |
| shareOfGivtImpressions | number | false | none | Share of GIVT Ad Counts % |
| givtIpv6Impressions | integer | false | none | IPv6 GIVT Ad Counts |
| givtIpv6ImpressionsRate | number | false | none | IPv6 GIVT Ad Counts % |
| sivtImpressions | integer | false | none | SIVT Ad Counts |
| sivtImpsRate | number | false | none | SIVT Ad Counts % |
| shareOfSivtImpressions | number | false | none | Share of SIVT Ad Counts % |
| shareOfGivtSivtImpressions | number | false | none | Share of IVT Ad Counts % |
| sivtIpv6Impressions | integer | false | none | IPv6 SIVT Ad Counts |
| sivtIpv6ImpressionsRate | number | false | none | IPv6 SIVT Ad Counts % |
| givtSivtIpv6Impressions | integer | false | none | IPv6 IVT Ad Counts |
| givtSivtIpv6ImpressionsRate | number | false | none | IPv6 IVT Ad Counts % |