Execute an Analytics query

Executes an Analytics query for data

HTTP request

GET /v1/apps/{app-id}/query

Security

Type Description
API key

Pass the API key via an X-Api-Key custom header or an api_key query parameter. [More info about authorization]

Basic Auth

Use the API key as either username or password with normal HTTP basic auth [More info about authorization]

Azure AAD Auth

Pass the AAD auth token in the 'Authorization' header. [More info about authorization]

URL parameters

Name Value Description
app-id string (uuid)

ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

Query parameters

Name Value Description
query string

The Analytics query. Learn more about the Analytics query syntax

timespan string (date-time-period)

Optional. The timespan over which to query data. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the query expression.

applications array (csv)

Application IDs to include in cross-application queries.

Responses

Status Code Description
200 Successful response
402 Payment required (the app is not in a required pricing tier)
404 Invalid app-id
429 Too many requests
503 Service unavailable