Skip to main content
POST
Run a report query

Authorizations

Authorization
string
header
required

An organization API key from Settings → Integrations → API Keys, or a Gauge CLI login token from gauge auth login.

Path Parameters

org
string
required

Body

application/json
dataset
enum<string>
required
Available options:
answers,
citations,
searchQueries,
aiTraffic
metrics
string[]
required
Required array length: 1 - 4 elements
dimensions
string[]
Maximum array length: 3
filters
QueryFilters · object
where
WhereIn · object[]
Maximum array length: 10
dateRange
DateRangeIn · object
granularity
enum<string>
default:day
Available options:
hour,
day,
week,
month
orderBy
OrderByIn · object[]
Maximum array length: 4
limit
integer
default:50
Required range: 1 <= x <= 1000

Response

OK

columns
Column · object[]
required
rows
Rows · object[]
required
labels
Labels · object
required
dateRange
DateRangeOut · object
required
truncated
boolean
required
cached
boolean
required
freshness
FreshnessOut · object
required