Skip to main content
POST
/
db-mgmt
/
api
/
query
Run an analytics query
curl --request POST \
  --url https://api2.upstackified.com/db-mgmt/api/query \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-pixel-id: <api-key>' \
  --data '
{
  "pixelId": "5f1e6a4f-...",
  "granularity": "day",
  "measures": [
    {
      "measure": "core.revenue"
    },
    {
      "measure": "orders.count"
    }
  ],
  "dateRange": {
    "start": "2026-04-01",
    "end": "2026-04-30"
  }
}
'
{
  "results": [
    {
      "granularity": "none",
      "dimensions": [
        "<string>"
      ],
      "dateRange": {
        "start": "2026-04-01",
        "end": "2026-04-30"
      },
      "compareDateRange": {
        "start": "2026-04-01",
        "end": "2026-04-30"
      },
      "measureDetails": [
        {
          "measure": "<string>",
          "isAverage": true,
          "isPercentage": true,
          "calculatedAverage": true,
          "success": true,
          "primaryAvg": 123,
          "compareAvg": 123,
          "primarySum": 123,
          "compareSum": 123,
          "percentDiff": 123,
          "hasPacing": true,
          "preferredTrendDirection": "up"
        }
      ],
      "data": {
        "primary": [
          {
            "dt": "<string>",
            "start": "<string>",
            "end": "<string>"
          }
        ],
        "compare": [
          {
            "dt": "<string>",
            "start": "<string>",
            "end": "<string>"
          }
        ]
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.upstackdata.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

Your Upstack API key. Starts with upstack_.

x-pixel-id
string
header
required

The pixel id the request targets.

Body

application/json
pixelId
string
required

Must match the x-pixel-id header (403 if it doesn't).

granularity
enum<string>
required
Available options:
none,
second,
minute,
hour,
day,
week,
month,
quarter,
year
measures
object[]
required
Required array length: 1 - 30 elements
dateRange
object
required
dimensions
string[]
Maximum array length: 5

Dimension id (see Measures & Dimensions).

filters
object[]
Maximum array length: 5
compareDateRange
object

Optional comparison period. Must not overlap dateRange; the server picks the preceding period if omitted (and granularitynone).

timezone
string

IANA timezone (e.g. America/New_York).

orderSettings
object

Order-level query settings — exclusion filters, pending/voided handling.

viewFilters
object[]

Response

Query results.

results
object[]
required