Query language

The q parameter of the Analytics Reports API tells the API which data to return. It uses a simplified SQL SELECT syntax: you list the columns you want, then optionally filter, group and sort them. The value must be URL-encoded.

adDomain,impressions,givtSivtRate WHERE day>='2026-02-06' AND day<='2026-02-06' ORDER BY impressions DESC

Syntax

[column [,column...]] [WHERE expression] [GROUP BY column [,column...]] [ORDER BY column [DESC]]

Select columns

Start the query with a comma-separated list of the dimensions and metrics you want. Each one becomes a property of every item in the response’s docs array, or a column in a CSV export.

fraudType,impressions,sivtImpressions,sivtImpsRate,givtImpressions,givtImpsRate

The examples on this page list columns with no space after each comma.

Filter with WHERE

A WHERE clause filters the rows. Each condition compares a column to a literal:

Literals take three forms:

Combine conditions

Join conditions with AND and OR, and group them with parentheses:

WHERE day>='2026-02-01' AND day<='2026-02-01' AND adultRisk='high'

WHERE day>='2026-02-01' AND day<='2026-02-01' AND (CONTAINS(LOWER(deviceMarketingName),LOWER('Iphone')))

Match text with CONTAINS

CONTAINS(dimension, literal) matches rows where the dimension’s value contains the literal text. Because values are case sensitive, the Contains specified value example wraps both arguments in LOWER():

CONTAINS(LOWER(deviceMarketingName),LOWER('Iphone'))

Set the date range

Filter on the day dimension. Dates are yyyy-mm-dd strings in single quotes. Every example on this page sets a start and end date like this:

WHERE day>='2026-02-01' AND day<='2026-02-01'

Use the same date twice for a single day. To choose the time zone the report data is synced in, use the timeZone request parameter (minutes from GMT; the default 0 is UTC). See Set the date range in the API guide.

Group with GROUP BY

GROUP BY takes one or more comma-separated columns. The examples group by the dimension they report on:

advertiserId,reach,impressions WHERE day>='2026-02-01' AND day<='2026-02-01' GROUP BY advertiserId

Sort with ORDER BY

ORDER BY takes one column, optionally followed by DESC:

ORDER BY impressions DESC

URL-encode the query

q must be URL-encoded. The query contains spaces, commas, quotes and comparison operators, and each one must be percent-encoded in the URL:

For example, this query:

adDomain,impressions,givtSivtRate WHERE day>='2026-02-06' AND day<='2026-02-06' ORDER BY impressions DESC

is sent as:

q=adDomain%2Cimpressions%2CgivtSivtRate%20WHERE%20day%3E%3D%272026-02-06%27%20AND%20day%3C%3D%272026-02-06%27%20ORDER%20BY%20impressions%20DESC

You rarely need to encode by hand. curl’s --get and --data-urlencode options encode the value for you:

curl --get "https://api.pixalate.com/api/v2/analytics/reports/default" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "q=adDomain,impressions,givtSivtRate WHERE day>='2026-02-06' AND day<='2026-02-06' ORDER BY impressions DESC" \
  --data-urlencode "limit=10"

Worked examples

These queries match reports in the Pixalate dashboard. Send each one as q to the report ID shown.

Dashboard (by advertiser)

The Dashboard report, which is the default report when you first log in to the Pixalate dashboard. Report ID: default.

advertiserId,reach,impressions,viewability,views,viewsRate,adsAboveTheFold,givtImpsRate,sivtImpsRate WHERE day>='2026-02-01' AND day<='2026-02-01' GROUP BY advertiserId ORDER BY impressions DESC

Domain

The Domain report listed under the Dashboard report in the main report section. Report ID: default.

adDomain,impressions,givtSivtRate WHERE day>='2026-02-06' AND day<='2026-02-06' ORDER BY impressions DESC

By fraud type

The By Fraud Type report, listed under Pre-Set Reports in the dashboard. Report ID: default.

fraudType,impressions,sivtImpressions,sivtImpsRate,givtImpressions,givtImpsRate WHERE day>='2026-02-01' AND day<='2026-02-01' GROUP BY fraudType ORDER BY impressions DESC

Each row holds the data for one fraud type. A row with a fraud type value always reports 100% IVT. A row with no fraud type value is 100% IVT-free.

By seller

The By Seller ID report, listed under Pre-Set Reports in the dashboard. kv7 is the Seller ID dimension. Report ID: default.

kv7,impressions,sivtImpressions,sivtImpsRate,givtImpressions,givtImpsRate WHERE day>='2026-02-01' AND day<='2026-02-01' GROUP BY kv7 ORDER BY impressions DESC

Specific bundle IDs

Data for a specific set of app bundle IDs (kv18). Report ID: default.

kv18,impressions,sivtImpressions,sivtImpsRate,givtImpressions,givtImpsRate WHERE day>='2026-02-01' AND day<='2026-02-01' AND kv18='com.mobilityware.solitaire' OR kv18='1407852246' OR kv18='com.zynga.words' GROUP BY kv18 ORDER BY impressions DESC

Contains a specified value

Data where a dimension’s value contains specific text, here device marketing names that contain “iphone” in any case. Report ID: default.

kv18,deviceBrandName,deviceMarketingName,impressions,sivtImpressions,sivtImpsRate,givtImpressions,givtImpsRate WHERE day>='2026-02-01' AND day<='2026-02-01' AND (CONTAINS(LOWER(deviceMarketingName),LOWER('Iphone'))) GROUP BY kv18 ORDER BY impressions DESC

Supply path

The By Supply Path report, listed under SPO Reports: Supply Path in the dashboard. Report ID: spo.

kv18,kv55,node1SellerId,node2SellerId,nodePathComplete,impressions,givtSivtRate WHERE day>='2026-02-01' AND day<='2026-02-01' ORDER BY impressions DESC

Source-destination traffic

The By Source-Destination Traffic report, listed under SPO Reports: Source Destination Traffic in the dashboard. Report ID: spoSrcDest.

src,dest,impressions,givtSivtRate,givtImpsRate,sivtImpsRate WHERE day>='2026-02-01' AND day<='2026-02-01' ORDER BY impressions DESC

Brand safety

App IDs with high adult risk, from the mobile Brand Safety report. Report ID: mobileBrandSafety.

kv18,adultRisk,impressions WHERE day>='2023-10-24' AND day<='2023-10-24' AND adultRisk='high' ORDER BY impressions DESC

Dimensions

Dimensions are the attributes of the data, returned as rows. For example, the adDomain dimension returns each domain value in its own row. Many dimensions align with the dimensions in Pixalate’s dashboard reporting. Which dimensions you can use depends on the report.

Available dimensions

SPO dimensions

These dimensions describe the supply chain object (SCO) and are used in the SPO reports. src and dest apply to the spoSrcDest report.

Metrics

Metrics are the numbers measured for each row of dimension values. For example, the impressions metric is the total number of impressions for each row. Many metrics align with the metrics in Pixalate’s dashboard reporting. The label is the name the metric has in the dashboard and in CSV exports. Rate metrics are returned as fractions, so 1 means 100%.

The Get analytics report reference also lists the dimensions and metrics in its response schema. If you need a dimension or metric that isn’t listed here, contact support@pixalate.com.

Related