{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Reporting API V3 — Developer Guide","description":"Sprinklr offers robust, convenient, and simple RESTful Web service APIs to integrate data from Sprinklr to any external system.","keywords":["Sprinklr API","Sprinklr Developer Portal","OAuth 2.0","RESTful API","Social Media API","Customer Experience API","Unified-CXM","Social Listening API"]},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"reporting-api-v3--developer-guide","__idx":0},"children":["Reporting API V3 — Developer Guide"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Applies to:"]}," Sprinklr Reporting API, version 3 (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/reports/*"]},"), OpenAPI tag ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Reporting V3"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/reporting"},"children":["Reporting"]}," (index) — Custom Query, Custom Query Using Widget Id, Batch Query, Fetch Reporting Engines, Fetch Report Names, Fetch Custom Metrics, Fetch Metrics and Dimensions"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-overview","__idx":1},"children":["1. Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Reporting API returns the same analytics data that Sprinklr's reporting dashboards display. The OpenAPI document describes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Reporting V3"]}," tag as:"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Run analytics queries and retrieve reporting metadata. Supports single, widget, and batch queries, listing reporting engines and enabled report names, fetching report metadata and custom measurements, retrieving viral trend insights, returning compiled backend query strings, and Research Assistant queries."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"11-the-four-concepts-you-need","__idx":2},"children":["1.1 The four concepts you need"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reporting is a four-level hierarchy. You must resolve each level before you can query."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Concept"},"children":["Concept"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What it is"},"children":["What it is"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"How to discover it"},"children":["How to discover it"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Reporting engine"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The data domain — Listening, Paid, Inbound Analytics, Voice, and so on. Identified by an id such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PLATFORM"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INBOUND_MESSAGE"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#4-get-reportsengine--list-reporting-engines"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reports/engine"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Report"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A dataset within an engine, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT_INSIGHTS"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST_INSIGHTS"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#5-get-reportsreport--list-report-names"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reports/report"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Dimensions"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupBys"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The attributes you slice by — channel, account, date."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#6-get-reportsmetadata--fetch-metrics-and-dimensions"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reports/metadata"]}]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Measurements"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projections"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The numbers you aggregate — impressions, followers, handling time."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#6-get-reportsmetadata--fetch-metrics-and-dimensions"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reports/metadata"]}]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#7-get-reportscustom-metric--fetch-custom-metrics"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reports/custom-metric"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"12-which-query-endpoint-should-i-use","__idx":3},"children":["1.2 Which query endpoint should I use?"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"If you…"},"children":["If you…"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Use"},"children":["Use"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Why"},"children":["Why"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Want data for a widget that already exists on a dashboard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#9-post-reportsquerywidget--custom-query-using-widget-id"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /reports/query/widget"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The widget already encodes the report, filters, dimensions and metrics. You supply only a time range and paging."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Want to build a query from scratch, or need filters the UI cannot express"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#8-post-reportsquery--custom-query"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /reports/query"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Full control over ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupBys"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projections"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sorts"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Need several queries answered in one round trip, or your widget draws from more than one report type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#10-post-reportsbatchquery--batch-query"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /reports/batchQuery"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2: ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"If the configured metrics and dimensions in a widget are being pulled from multiple report types, batch query API is used.\""]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"13-the-generate-api-payload-workflow","__idx":4},"children":["1.3 The Generate API Payload workflow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The intended path to a working payload is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," to hand-write one. Build the widget in the UI, then export its payload:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create a dashboard and add a widget that shows the data you want."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Grant your user the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Generate Widget API Payload"]}]}," role permission — Governance Console → All Settings → Workspace Roles (or Global Roles) → Create/Edit Role."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["On the widget, open the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["three-dot menu → Generate API v2 Payload"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Choose ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Copy Code"]}," and paste the result into your request body."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Two constraints from the Blueprints article that surprise people:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"a separate API payload needs to be generated for every widget within the dashboard.\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"dashboard level filters will not be reflected in the payload that is generated.\""]}," — fold any dashboard-level filter into the widget, or add it manually to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To use the exported payload with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#9-post-reportsquerywidget--custom-query-using-widget-id"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /reports/query/widget"]}]},", find ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["widgetId"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["inside the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}," object"]}," of the generated payload."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"14-prerequisites","__idx":5},"children":["1.4 Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A registered Developer Portal application with an API key and secret. Best practice from the Blueprints article: register the app against a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["service account"]},", not a personal user account, so the integration survives staff changes."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An OAuth 2.0 access token. Validate it against the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["\"ME\" endpoint"]}," before debugging anything reporting-specific."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reporting ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["view permission"]}," for the dashboards and workspaces you intend to query. A token whose user lacks workspace (client) access is the most common cause of a successful-but-empty response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Generate Widget API Payload"]}]}," permission if you intend to export payloads from the UI."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"15-conventions-used-in-this-guide","__idx":6},"children":["1.5 Conventions used in this guide"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Base URL is written ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{base}"]}," and stands for `https://{host}/{env}."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Credentials always appear as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{accessToken}}"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{apiKey}}"]},". Never paste a real token into a shared document or ticket."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All epoch timestamps are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["milliseconds"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-base-urls-and-environments","__idx":7},"children":["2. Base URLs and environments"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{base} = https://{host}/{env}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Full request path:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{base}/api/v3/reports/{operation}\n"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Segment"},"children":["Segment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{host}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Region-specific API host, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api2.sprinklr.com"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api3.sprinklr.com"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Environment/partner path segment issued with your Developer Portal application"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-authentication-and-common-headers","__idx":8},"children":["3. Authentication and common headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All seven endpoints use the same headers. The V2 pages document four:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer {{accessToken}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OAuth 2.0 access token."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{apiKey}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your Developer Portal API key. The V2 pages show the literal placeholder value ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api-key"]},"; substitute your own key."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["On ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required for the three query endpoints."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recommended"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declares the acceptable response type."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Header casing note: HTTP header names are case-insensitive, so ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["key"]}," are equivalent."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"discovery-endpoints","__idx":9},"children":["Discovery endpoints"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The four ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," endpoints resolve the hierarchy described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#11-the-four-concepts-you-need"},"children":["§1.1"]},". Call them in the order below the first time you integrate; cache the results afterwards, since engine and report catalogues change rarely."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-get-reportsengine--list-reporting-engines","__idx":10},"children":["4. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reports/engine"]}," — List reporting engines"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Summary."]}," List reporting engines visible to the current partner."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["operationId."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReportingApiV3_listReportingEngines"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," with the standard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}," envelope."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the entry point. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," values it returns are what you pass as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reportingEngine"]}," in a query body and as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reportingEngineId"]}," to the other three discovery endpoints."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"41-parameters","__idx":11},"children":["4.1 Parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["None. The result is scoped implicitly to the partner and user behind the access token."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"42-example-request","__idx":12},"children":["4.2 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \\\n  'https://api3.sprinklr.com/{env}/api/v3/reports/engine' \\\n  -H 'Authorization: Bearer {{accessToken}}' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"43-example-response","__idx":13},"children":["4.3 Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    { \"id\": \"PLATFORM\", \"name\": \"Social Analytics\" },\n    { \"id\": \"INBOUND_MESSAGE\", \"name\": \"Inbound Analytics\" },\n    { \"id\": \"LISTENING\", \"name\": \"Listening\" }\n  ],\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"44-reporting-engines","__idx":14},"children":["4.4 Reporting engines"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following 38 engines were returned by the V2 endpoint. The set visible to ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["your"]}," token depends on your partner's licensed products, so always call the endpoint rather than hard-coding this list."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"id"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"name"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADOPTION"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Adoption"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADOPTION_ENGAGEMENT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Adoption Engagement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUDIENCE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Audience"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUDIENCE_ACTIVITY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Audience Activity"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUDIENCE_INSIGHTS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Audience Insights"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUDIENCE_INSIGHT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Social DMP"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUDIENCE_LEAD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AUDIENCE_LEAD"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BENCHMARKING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Benchmarking"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SELF_SERVE_BENCHMARKING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Benchmarking"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMMUNITY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Community"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONSUMPTION"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consumption Analytics"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CUSTOM_ENTITY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Entity"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GALLERY_AUDIENCE_ACTIVITY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Gallery"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INBOUND_MESSAGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Inbound Analytics"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LISTENING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RDB_FIREHOSE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Explorer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SELF_SERVE_RDB_FIREHOSE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Explorer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LIVE_DATASET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Live Dataset"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LYEARN_REPORTING_ENGINE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["LYEARN_REPORTING_ENGINE"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MONITORING_LOG"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Monitoring Log"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OUTBOUND_MESSAGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Outbound Message"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Paid"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PLATFORM"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Social Analytics"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PLATFORM_HEALTH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Platform Health"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REAL_TIME"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Real Time"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SELF_SERVE_MESSAGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Self Serve"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SELF_SERVE_LISTENING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Self Serve"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SPR_TASK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Task"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["STORE_FRONT_AUDIENCE_ACTIVITY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Store"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["STORY_MESSAGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Story Analytics"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SELF_SERVE_STORY_MESSAGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Story Analytics"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNIFIED_ANALYTICS_REPORTING_ENGINE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unified Analytics"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNIVERSAL_COMMERCE_EVENT_ENGINE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Universal Commerce"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNIVERSAL_PROFILE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Universal Profile"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VOICE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Voice Analytics"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VOICE_SEGMENT_ACTIVATION_CONFIG"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["VOICE_SEGMENT_ACTIVATION_CONFIG"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YOUTUBE_REPORTING_ENGINE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["YouTube Analytics"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["wfm_reporting"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["wfm_reporting"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Three things to note before you build a UI on top of this list:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," is not unique."]}," Benchmarking, Listening Explorer, Self Serve and Story Analytics each appear twice under different ids. Key your code on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", and if you present a picker, disambiguate the duplicates yourself."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," casing is not uniform."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["wfm_reporting"]}," is lower-case while every other id is upper snake case. Do not normalise case when echoing an id back to the API."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Some entries expose an internal identifier as the display name"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUDIENCE_LEAD"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LYEARN_REPORTING_ENGINE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VOICE_SEGMENT_ACTIVATION_CONFIG"]},". These are unlikely to be presentable to end users as-is."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-get-reportsreport--list-report-names","__idx":15},"children":["5. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reports/report"]}," — List report names"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Summary."]}," List the reports enabled for a reporting engine."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," with the standard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}," envelope."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Given an engine id from, this returns the reports available within it. The values feed the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report"]}," field of a query body and the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reportNames"]}," parameter."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"51-parameters","__idx":16},"children":["5.1 Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reportingEngineId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["See note"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The reporting engine id, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PLATFORM"]},". Obtain it from ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#4-get-reportsengine--list-reporting-engines"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reports/engine"]}]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"52-example-request","__idx":17},"children":["5.2 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \\\n  'https://api3.sprinklr.com/{env}/api/v3/reports/report?reportingEngineId=PLATFORM' \\\n  -H 'Authorization: Bearer {{accessToken}}' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"53-example-response","__idx":18},"children":["5.3 Example response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response is an array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{id, name}"]}," objects, one per report. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PLATFORM"]}," engine returns several hundred; this is an abridged extract."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    { \"id\": \"ACCOUNT_INBOUND_VOLUME\", \"name\": \"ACCOUNT_INBOUND_VOLUME\" },\n    { \"id\": \"ACCOUNT_INSIGHTS\", \"name\": \"ACCOUNT_INSIGHTS\" },\n    { \"id\": \"AGENT_PERFORMANCE_AGGREGATED_REPORT\", \"name\": \"AGENT_PERFORMANCE_AGGREGATED_REPORT\" },\n    { \"id\": \"ANALYTICS\", \"name\": \"ANALYTICS\" },\n    { \"id\": \"FACEBOOK_HOURLY_INSIGHTS\", \"name\": \"FACEBOOK_HOURLY_INSIGHTS\" },\n    { \"id\": \"POST_INSIGHTS\", \"name\": \"POST_INSIGHTS\" },\n    { \"id\": \"CaseSLAReport\", \"name\": \"CaseSLAReport\" }\n  ],\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"54-response-parameters","__idx":19},"children":["5.4 Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One object per report enabled for the engine."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Report identifier. Pass this as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report"]}," in a query body."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Display name. In practice identical to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," for most reports."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error objects, empty on success."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note that report ids are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," uniformly upper snake case — the V2 response mixes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT_INSIGHTS"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CaseSLAReport"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CaseProcessingSLAReport"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ComprehensiveCaseSLAReport"]},". Treat report ids as opaque, case-sensitive strings."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-get-reportsmetadata--fetch-metrics-and-dimensions","__idx":20},"children":["6. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reports/metadata"]}," — Fetch metrics and dimensions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Summary."]}," Get report metadata for a reporting engine."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["operationId."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReportingApiV3_getMetadata"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," with the standard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}," envelope."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the endpoint that tells you ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["what you are allowed to put in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projections"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupBys"]}]},". For each requested report it returns the full catalogue of measurements (metrics), dimensions, and filter dimensions, with their field names, data types and display names."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"61-parameters","__idx":21},"children":["6.1 Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required (V3 spec)"},"children":["Required (V3 spec)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required (V2)"},"children":["Required (V2)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reportingEngineId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reporting engine id."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reportNames"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional comma-separated report names; ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["omit to return all reports"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"62-example-request","__idx":22},"children":["6.2 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \\\n  'https://api3.sprinklr.com/{env}/api/v3/reports/metadata?reportingEngineId=PLATFORM&reportNames=POST_INSIGHTS' \\\n  -H 'Authorization: Bearer {{accessToken}}' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To request several reports, comma-separate them:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"?reportingEngineId=PLATFORM&reportNames=POST_INSIGHTS,ACCOUNT_INSIGHTS\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"63-example-response","__idx":23},"children":["6.3 Example response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Heavily abridged — a real response for one report is several hundred lines."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"POST_INSIGHTS\": {\n      \"recordType\": \"LIFETIME\",\n      \"displayName\": \"POST_INSIGHTS\",\n      \"dateFieldName\": \"date\",\n      \"skipVisibilityFilters\": false,\n      \"measurements\": [\n        {\n          \"type\": \"CUMULATIVE\",\n          \"measurementGroups\": [\"FACEBOOK\"],\n          \"name\": \"POST_FB_NEGATIVE_FEEDBACK_BY_TYPE_UNIQUE_HIDE_ALL_CLICKS\",\n          \"fieldName\": \"POST_FB_NEGATIVE_FEEDBACK_BY_TYPE_UNIQUE_HIDE_ALL_CLICKS\",\n          \"displayName\": \"Facebook Post Negative Feedback Unique All Hide\",\n          \"isShared\": false,\n          \"filterMeasurement\": true,\n          \"hidden\": false,\n          \"enabledForAiConcierge\": false,\n          \"channelTypes\": [\"FACEBOOK\"]\n        }\n      ],\n      \"dimensions\": [\n        {\n          \"type\": \"SCRIPT\",\n          \"name\": \"postFeatures.ocr_gcv\",\n          \"fieldName\": \"postFeatures.ocr_gcv\",\n          \"displayName\": \"Creative Insight: All Text in Asset\",\n          \"filterDimension\": true,\n          \"multiValue\": true,\n          \"sortable\": false,\n          \"lookupSupported\": true,\n          \"hidden\": false\n        }\n      ],\n      \"oldCustomFieldDimensionName\": \"OUTBOUND_CUSTOM_PROPERTY_NAME\"\n    }\n  },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"64-response-parameters","__idx":24},"children":["6.4 Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Keyed by report name — one entry per report you requested."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Metadata for that report."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}.recordType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Record type, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LIFETIME"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}.measurements"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Measurement (metric) objects. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}," of each is what you put in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projections[].measurementName"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}.dimensions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dimension objects. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}," of each is what you put in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupBys[].dimensionName"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters[].dimensionName"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}.filterDimensions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dimension objects usable specifically for filtering."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}.oldCustomFieldDimension"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Legacy custom-field dimension details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}.oldCustomFieldDimensionName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the legacy custom-field dimension."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}.skipVisibilityFilters"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether visibility filters are bypassed for this report."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}.displayName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Display name of the report."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}.dateFieldName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The field used as the date field — a good default for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timeField"]}," in a query body."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error objects, empty on success."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Commonly useful fields on each measurement and dimension object:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The identifier to use in a query. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["displayName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Human-readable label as shown in the UI."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NUMERIC"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIME_DIFFERENCE"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CUMULATIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELTA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SCRIPT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CUSTOM"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["measurementGroups"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Groups the measurement belongs to, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["COMMON"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VK"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelTypes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Channels the measurement applies to."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hidden measurements are generally not intended for direct use."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterMeasurement"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterDimension"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the field may be used in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projectionFilters"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["multiValue"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether a dimension can hold multiple values per record."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sortable"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the field can be used in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sorts"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupSupported"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the dimension's values can be resolved through a lookup."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["translatable"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the dimension's values can be translated."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dashboardGroups"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The dashboard groups the dimension is exposed in, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PARTNER_DASHBOARD"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OVERALL_DASHBOARD"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["QM_DASHBOARDS"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"65-resolving-a-custom-property-to-its-ui-label","__idx":25},"children":["6.5 Resolving a custom property to its UI label"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a response contains a custom property field name you do not recognise, copy that field name from the request and pass it to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["fetch custom field using field name"]}," API to retrieve the label shown in the UI."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"7-get-reportscustom-metric--fetch-custom-metrics","__idx":26},"children":["7. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reports/custom-metric"]}," — Fetch custom metrics"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Summary."]}," Get custom measurements for a reporting engine."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["operationId."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReportingApiV3_getCustomMetrics"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," with the standard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}," envelope."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Custom measurements are metrics your organisation has ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["defined itself"]}," in Sprinklr — typically a formula over one or more standard measurements. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#6-get-reportsmetadata--fetch-metrics-and-dimensions"},"children":["§6"]}," returns the standard catalogue; this endpoint returns the customer-defined additions, together with the formula behind each."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"71-parameters","__idx":27},"children":["7.1 Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required (V3 spec)"},"children":["Required (V3 spec)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required (V2)"},"children":["Required (V2)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reportingEngineId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reporting engine id."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reportNames"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional comma-separated report names; ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["omit for all reports"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"72-example-request","__idx":28},"children":["7.2 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \\\n  'https://api3.sprinklr.com/{env}/api/v3/reports/custom-metric?reportingEngineId=PLATFORM&reportNames=ACCOUNT_INSIGHTS' \\\n  -H 'Authorization: Bearer {{accessToken}}' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"73-example-response","__idx":29},"children":["7.3 Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"ACCOUNT_INSIGHTS\": [\n      {\n        \"script\": \" (__formula__elem__453*1000)\",\n        \"requiredProjections\": [\n          {\n            \"key\": \"__formula__elem__453\",\n            \"measurement\": \"FOLLOWERS_COUNT\",\n            \"aggregateFunction\": \"SUM\"\n          }\n        ],\n        \"measurementGroups\": [\"COMMON\"],\n        \"groupNames\": [\"Custom Measurement\"],\n        \"isShared\": false,\n        \"sharedKey\": \"EXAMPLE_METRIC_1\",\n        \"filterMeasurement\": true,\n        \"name\": \"EXAMPLE_METRIC_1\",\n        \"fieldName\": \"EXAMPLE_METRIC_1\",\n        \"displayName\": \"Followers per thousand\",\n        \"lcName\": \"followers per thousand\",\n        \"hidden\": false,\n        \"enabledForAiConcierge\": false,\n        \"dataType\": \"NUMERIC\",\n        \"additional\": {\n          \"measurement_type\": \"Custom Measurement\",\n          \"clientId\": 0000,\n          \"IS_PERMISSIBLE\": \"false\",\n          \"definitionId\": \"000000000000000000000000\"\n        }\n      },\n      {\n        \"script\": \" (__formula__elem__1001+__formula__elem__1002)\",\n        \"requiredProjections\": [\n          {\n            \"key\": \"__formula__elem__1001\",\n            \"measurement\": \"FOLLOWERS_COUNT\",\n            \"aggregateFunction\": \"SUM\"\n          },\n          {\n            \"key\": \"__formula__elem__1002\",\n            \"measurement\": \"FACEBOOK_PAGE_FANS\",\n            \"aggregateFunction\": \"SUM\"\n          }\n        ],\n        \"type\": \"CALCULATED\",\n        \"measurementGroups\": [\"COMMON\"],\n        \"groupNames\": [\"Custom Measurement\"],\n        \"isShared\": false,\n        \"sharedKey\": \"EXAMPLE_METRIC_2\",\n        \"filterMeasurement\": true,\n        \"name\": \"EXAMPLE_METRIC_2\",\n        \"fieldName\": \"EXAMPLE_METRIC_2\",\n        \"displayName\": \"Total audience\",\n        \"lcName\": \"total audience\",\n        \"filters\": [],\n        \"hidden\": false,\n        \"enabledForAiConcierge\": false,\n        \"dataType\": \"NUMERIC\",\n        \"additional\": {\n          \"definitionId\": \"000000000000000000000001\",\n          \"measurement_type\": \"Custom Measurement\",\n          \"IS_PERMISSIBLE\": \"false\",\n          \"clientId\": 0000\n        }\n      }\n    ]\n  },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["The metric names, display names, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sharedKey"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["definitionId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}," values above are illustrative placeholders and do not identify a real customer configuration."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"74-response-parameters","__idx":30},"children":["7.4 Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Container keyed by report name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom measurement objects for that report."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].script"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The formula evaluated to produce the metric, expressed over ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["__formula__elem__*"]}," placeholders."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].requiredProjections"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The standard measurements the formula depends on. Each has a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["key"]}," (matching a placeholder in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["script"]},"), a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["measurement"]}," name, and an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["aggregateFunction"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Measurement type, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CALCULATED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELTA"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].measurementGroups"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Groups the measurement belongs to."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].groupNames"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Group display names, typically ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Custom Measurement"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].isShared"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the measurement is shared."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].sharedKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Key for shared measurements."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].filterMeasurement"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the measurement can be used in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projectionFilters"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].name"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier to use in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projections[].measurementName"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].displayName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Display label."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].lcName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lower-cased display name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].shortName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Abbreviated label."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].hidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the measurement is hidden in the UI."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].enabledForAiConcierge"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the measurement is exposed to AI Concierge."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].dataType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["For example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NUMERIC"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIME_DIFFERENCE"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].filters"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filters baked into the custom measurement definition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].additional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Definition metadata — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["definitionId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["measurement_type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IS_PERMISSIBLE"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].channelTypes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Channels the measurement applies to."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.{reportName}[].code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal label code."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error objects, empty on success."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To use a custom metric in a query, put its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projections[].measurementName"]}," exactly as returned — Sprinklr resolves the formula server-side. You do not need to reproduce ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["script"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requiredProjections"]}," yourself."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"query-endpoints","__idx":31},"children":["Query endpoints"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"8-post-reportsquery--custom-query","__idx":32},"children":["8. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /reports/query"]}," — Custom query"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Summary."]}," Execute a reporting query (plain ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReportRequest"]},")."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["operationId."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReportingApiV3_query"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReportRequest"]},", required."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," with the standard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}," envelope."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The general-purpose endpoint. You specify the engine, the report, the time range, and the dimensions, metrics, filters and sorts explicitly."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"81-parameters","__idx":33},"children":["8.1 Parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["No path or query parameters. Everything is in the body — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#111-reportrequest"},"children":["§11.1"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"82-example-request","__idx":34},"children":["8.2 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n  'https://api3.sprinklr.com/{env}/api/v3/reports/query' \\\n  -H 'Authorization: Bearer {{accessToken}}' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'Accept: application/json' \\\n  -d '{\n    \"reportingEngine\": \"PLATFORM\",\n    \"report\": \"ACCOUNT_INSIGHTS\",\n    \"startTime\": 1735689600000,\n    \"endTime\": 1738368000000,\n    \"timeZone\": \"America/New_York\",\n    \"page\": 0,\n    \"pageSize\": 100,\n    \"groupBys\": [\n      {\n        \"heading\": \"Channel\",\n        \"dimensionName\": \"SOCIAL_NETWORK\",\n        \"groupType\": \"FIELD\"\n      }\n    ],\n    \"projections\": [\n      {\n        \"heading\": \"Followers\",\n        \"measurementName\": \"FOLLOWERS_COUNT\",\n        \"aggregateFunction\": \"SUM\"\n      }\n    ],\n    \"filters\": [\n      {\n        \"dimensionName\": \"ACCOUNT_ID\",\n        \"filterType\": \"IN\",\n        \"values\": [\"000000000000000000000000\"]\n      }\n    ],\n    \"sorts\": [\n      {\n        \"heading\": \"Followers\",\n        \"order\": \"DESC\"\n      }\n    ],\n    \"jsonResponse\": true\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"83-example-response","__idx":35},"children":["8.3 Example response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["jsonResponse"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", rows are returned as objects keyed by heading:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"data\": [\n      {\n        \"Channel\": \"FACEBOOK\",\n        \"Followers\": 128394\n      },\n      {\n        \"Channel\": \"TWITTER\",\n        \"Followers\": 94021\n      }\n    ],\n    \"hasMore\": false\n  },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["jsonResponse"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},", the same result arrives in the compact columnar form — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#122-the-jsonresponse-toggle"},"children":["§12.2"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"84-response-parameters","__idx":36},"children":["8.4 Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Result container."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Result rows. Each key corresponds to a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["heading"]}," you supplied in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupBys"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projections"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.hasMore"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," if further rows are available beyond this page. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#123-pagination-and-hasmore"},"children":["§12.3"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error objects, empty on success."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"9-post-reportsquerywidget--custom-query-using-widget-id","__idx":37},"children":["9. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /reports/query/widget"]}," — Custom query using widget id"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Summary."]}," Execute a reporting query for a dashboard widget."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["operationId."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReportingApiV3_queryWidget"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WidgetReportRequest"]},", required."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," with the standard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}," envelope."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The widget already defines the report, engine, dimensions, metrics and filters, so the body carries only the time range, paging and formatting options. This is the lowest-effort way to pull dashboard data programmatically."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"91-parameters","__idx":38},"children":["9.1 Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required (V3 spec)"},"children":["Required (V3 spec)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["widgetId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Widget id."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["replaceHeadingsWithLabel"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Forwarded to the underlying widget request."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"92-finding-the-widget-id","__idx":39},"children":["9.2 Finding the widget id"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the dashboard containing the widget."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Widget three-dot menu → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Generate API v2 Payload"]}," → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Copy Code"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the copied payload, locate ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["widgetId"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["inside the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}," object"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"93-request-body-fields","__idx":40},"children":["9.3 Request body fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WidgetReportRequest"]}," defines only eight fields."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required (V2 page)"},"children":["Required (V2 page)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer (int64)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Start of the time range, epoch ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["milliseconds"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["endTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer (int64)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["End of the time range, epoch ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["milliseconds"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer (int32)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Zero-based page index."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer (int32)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rows per page. Keep at or below ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["1000"]}," — see the warning below."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["interval"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bucket interval. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Only required when the widget uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"groupType\": \"DATE_HISTOGRAM\""]},"."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipResolve"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},". When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", suppresses resolution of referenced entities."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["jsonResponse"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},". Controls response shape — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#122-the-jsonresponse-toggle"},"children":["§12.2"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timeZone"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["IANA time zone, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["America/New_York"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"94-example-request","__idx":41},"children":["9.4 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n  'https://api3.sprinklr.com/{env}/api/v3/reports/query/widget?widgetId=000000000000000000000000' \\\n  -H 'Authorization: Bearer {{accessToken}}' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'Accept: application/json' \\\n  -d '{\n    \"startTime\": 1735689600000,\n    \"endTime\": 1738368000000,\n    \"timeZone\": \"America/New_York\",\n    \"page\": 0,\n    \"pageSize\": 1000,\n    \"skipResolve\": false,\n    \"jsonResponse\": false\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"95-example-response","__idx":42},"children":["9.5 Example response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["jsonResponse"]}," set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},", the widget endpoint returns the columnar form:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"headings\": [\"Channel\", \"Followers\"],\n    \"rows\": [\n      [\"FACEBOOK\", 128394],\n      [\"TWITTER\", 94021]\n    ]\n  },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"96-response-parameters","__idx":43},"children":["9.6 Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Result container."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.headings"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of strings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Column headings, in the order the widget defines them."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.rows"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of arrays"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Result rows. Each inner array is positionally aligned with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["headings"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error objects, empty on success."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"10-post-reportsbatchquery--batch-query","__idx":44},"children":["10. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /reports/batchQuery"]}," — Batch query"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Summary."]}," Execute multiple reporting queries in one request."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["operationId."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReportingApiV3_batchQuery"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchReportRequest"]},", required."," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," with the standard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}," envelope."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this when you need several results in one round trip, or when a single widget draws its metrics and dimensions from more than one report type. From the V2 page:"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the configured metrics and dimensions in a widget are being pulled from multiple report types, batch query API is used."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"101-request-body-fields","__idx":45},"children":["10.1 Request body fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required (V2 page)"},"children":["Required (V2 page)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requests"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A map of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["arbitrary caller-chosen keys"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReportRequest"]}," objects. The keys you send are echoed back in the response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["collate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Default ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},". Groups multiple queries together in the response."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"102-example-request","__idx":46},"children":["10.2 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n  'https://api3.sprinklr.com/{env}/api/v3/reports/batchQuery' \\\n  -H 'Authorization: Bearer {{accessToken}}' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'Accept: application/json' \\\n  -d '{\n    \"requests\": {\n      \"req1\": {\n        \"reportingEngine\": \"PLATFORM\",\n        \"report\": \"ACCOUNT_INSIGHTS\",\n        \"startTime\": 1735689600000,\n        \"endTime\": 1738368000000,\n        \"timeZone\": \"America/New_York\",\n        \"page\": 0,\n        \"pageSize\": 100,\n        \"groupBys\": [\n          { \"heading\": \"Channel\", \"dimensionName\": \"SOCIAL_NETWORK\", \"groupType\": \"FIELD\" }\n        ],\n        \"projections\": [\n          { \"heading\": \"Followers\", \"measurementName\": \"FOLLOWERS_COUNT\", \"aggregateFunction\": \"SUM\" }\n        ],\n        \"filters\": []\n      },\n      \"req2\": {\n        \"reportingEngine\": \"INBOUND_MESSAGE\",\n        \"report\": \"INBOUND_CASE\",\n        \"startTime\": 1735689600000,\n        \"endTime\": 1738368000000,\n        \"timeZone\": \"America/New_York\",\n        \"page\": 0,\n        \"pageSize\": 100,\n        \"groupBys\": [\n          { \"heading\": \"Channel\", \"dimensionName\": \"SOCIAL_NETWORK\", \"groupType\": \"FIELD\" }\n        ],\n        \"projections\": [\n          { \"heading\": \"Volume\", \"measurementName\": \"INBOUND_COUNT\", \"aggregateFunction\": \"SUM\" }\n        ],\n        \"filters\": []\n      }\n    },\n    \"collate\": false\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"103-example-response","__idx":47},"children":["10.3 Example response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Results are returned in a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reports"]}," map keyed by the same keys you sent."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"reports\": {\n      \"req1\": {\n        \"headings\": [\"Channel\", \"Followers\"],\n        \"rows\": [\n          [\"FACEBOOK\", 128394],\n          [\"TWITTER\", 94021]\n        ]\n      },\n      \"req2\": {\n        \"headings\": [\"Channel\", \"Volume\"],\n        \"rows\": [\n          [\"FACEBOOK\", 4821],\n          [\"TWITTER\", 3107]\n        ]\n      }\n    }\n  },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"104-response-parameters","__idx":48},"children":["10.4 Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Result container."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.reports"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map keyed by your request keys."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.reports.{key}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Result for that sub-query, in the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["headings"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rows"]}," form as."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error objects, empty on success."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"105-the-additional-object-in-batch-payloads","__idx":49},"children":["10.5 The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}," object in batch payloads"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The V2 page documents these sub-fields of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}," on a batch sub-request. They are typically populated automatically by the UI payload generator."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-field"},"children":["Sub-field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["translateResponse"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the response should be translated."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dashboardId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Source dashboard identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["engine"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reporting engine for the sub-request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["widgetId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Source widget identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["showTotal"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether to include a total row."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Currency"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Currency for monetary measurements."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["chartType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Chart type the widget renders."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["showRolloverTrends"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether rollover trend data is included."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TABULAR"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tabular rendering flag."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"111-reportrequest","__idx":50},"children":["11.1 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReportRequest"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required (V2)"},"children":["Required (V2)"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reportingEngine"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Engine id from ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#4-get-reportsengine--list-reporting-engines"},"children":["§4"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Report id from ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#5-get-reportsreport--list-report-names"},"children":["§5"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer (int64)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Start of range, epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["endTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer (int64)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["End of range, epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timeZone"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["IANA time zone."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer (int32)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Zero-based page index."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer (int32)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rows per page. Keep at or below 1000."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupBys"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#113-group_reporting"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Group"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dimensions to slice by."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projections"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#114-projection_reporting"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Projection"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Metrics to aggregate."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#112-filter_reporting"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filters applied before aggregation. Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[]"]}," if you have none."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["jsonResponse"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response shape toggle — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#122-the-jsonresponse-toggle"},"children":["§12.2"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sorts"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#115-sort_reporting"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sort"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Result ordering."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projectionDecorations"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of strings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Derived columns — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#117-reference-enums"},"children":["§11.7"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Free-form options — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#116-the-additional-object"},"children":["§11.6"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timeField"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not documented in V2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The date field the range applies to. Default comes from the report's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateFieldName"]}," (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#64-response-parameters"},"children":["§6.4"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projectionFilters"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#112-filter_reporting"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not documented in V2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filters applied to aggregated measurement values, after grouping."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipResolve"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not documented in V2"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Suppresses entity resolution."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"112-filter_reporting","__idx":51},"children":["11.2 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter_reporting"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensionName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dimension to filter on. Use a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldName"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Comparison operator."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Values to compare against."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional filter configuration."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"113-group_reporting","__idx":52},"children":["11.3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Group_reporting"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["heading"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Column heading for this dimension in the response. This is the key you will read in the result rows."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensionName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dimension to group by."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Grouping strategy."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional grouping configuration."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["namedFilters"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map of name to an array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Filter"]}," objects, for named sub-groupings."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"114-projection_reporting","__idx":53},"children":["11.4 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Projection_reporting"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["heading"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Column heading for this metric in the response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["measurementName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Measurement to aggregate. Use a `fieldName"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["aggregateFunction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Aggregation to apply."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional projection configuration."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"115-sort_reporting","__idx":54},"children":["11.5 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sort_reporting"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["heading"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The heading to sort by. Must match a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["heading"]}," you defined in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupBys"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projections"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["order"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ASC"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DESC"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note that sorting is keyed on ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["heading"]}]},", not on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensionName"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["measurementName"]}," — so headings must be unique within a request if you intend to sort."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"116-the-additional-object","__idx":55},"children":["11.6 The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}," object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Key"},"children":["Key"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Documented effect"},"children":["Documented effect"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SKIP_RESOLVER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," to suppress automatic resolution of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CASE"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ASSOCIATED_CASE"]}," descriptions. Useful when you want raw ids and faster responses."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Batch sub-requests carry additional key."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"117-reference-enums","__idx":56},"children":["11.7 Reference enums"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All five fields are plain ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: string"]}," in V3. The values below are taken from the V2 documentation and are the only published list."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType"]}]}," — used in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters[]"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projectionFilters[]"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Value is in the supplied list."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NIN"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Value is not in the supplied list."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EQUALS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Exact match."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Greater than."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GTE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Greater than or equal to."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Less than."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LTE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Less than or equal to."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BETWEEN"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Within a range."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["STARTS_WITH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String prefix match."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Substring match."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EXISTS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Field is present."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FILTER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Composite / nested filter."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupType"]}]}," — used in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupBys[]"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FIELD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Group by the raw field value."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DATE_HISTOGRAM"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bucket by time interval. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["interval"]}," on widget queries."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIME_OF_DAY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bucket by hour of day."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DAY_OF_WEEK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bucket by day of week."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MONTH_OF_YEAR"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bucket by month."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["aggregateFunction"]}]}," — used in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projections[]"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUM"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AVG"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Mean."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MIN"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Minimum."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MAX"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["STATS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Summary statistics."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["order"]}]}," — used in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sorts[]"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ASC"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DESC"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projectionDecorations"]}]}," — derived columns added alongside a projection:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CHANGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Absolute change versus the comparison period."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PERCENTAGE_CHANGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Percentage change versus the comparison period."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PERCENTAGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Share of total."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"12-response-format-and-status-codes","__idx":57},"children":["12. Response format and status codes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"121-the-envelope","__idx":58},"children":["12.1 The envelope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All seven endpoints return the standard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}," envelope:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The payload. Shape varies by endpoint and by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["jsonResponse"]}," — see below."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Error"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error objects. Empty on success."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ResponseMetadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response metadata."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"122-the-jsonresponse-toggle","__idx":59},"children":["12.2 The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["jsonResponse"]}," toggle"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["jsonResponse"]}," changes the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["structure"]}," of the result, not merely its formatting. This trips up almost everyone migrating."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"jsonResponse"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["jsonResponse"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Shape"},"children":["Shape"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Best for"},"children":["Best for"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"data\": {\"data\": [ {heading: value, …} ], \"hasMore\": false}}"]}," — an array of objects, each keyed by heading."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Readability; direct mapping to typed models."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"data\": {\"headings\": [...], \"rows\": [[...]]}}"]}," — a heading array plus positionally aligned row arrays."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Compactness; large result sets; direct load into a dataframe or CSV."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Four distinct response shapes appear across the seven endpoints:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Shape"},"children":["Shape"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#4-get-reportsengine--list-reporting-engines"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reports/engine"]}]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#5-get-reportsreport--list-report-names"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reports/report"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," is an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["array"]}," of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{id, name}"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#6-get-reportsmetadata--fetch-metrics-and-dimensions"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reports/metadata"]}]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#7-get-reportscustom-metric--fetch-custom-metrics"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /reports/custom-metric"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," is an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["object keyed by report name"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#8-post-reportsquery--custom-query"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /reports/query"]}]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#9-post-reportsquerywidget--custom-query-using-widget-id"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /reports/query/widget"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.data"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.hasMore"]},", ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["or"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.headings"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.rows"]},", per ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["jsonResponse"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#10-post-reportsbatchquery--batch-query"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /reports/batchQuery"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.reports"]},", a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["map keyed by your request keys"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"124-status-codes","__idx":60},"children":["12.4 Status codes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every one of the seven operations declares exactly these five:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Code"},"children":["Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Typical cause"},"children":["Typical cause"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bad Request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Malformed body; unknown dimension or measurement; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}," above your partner limit; invalid time range."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unauthorized"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing, expired or invalid access token."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Forbidden"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Token valid but the user lacks reporting or workspace access."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not Found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unknown ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["widgetId"]},", engine id or report name."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"13-v2--v3-migration","__idx":61},"children":["13. V2 → V3 migration"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"131-endpoint-mapping","__idx":62},"children":["13.1 Endpoint mapping"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V2"},"children":["V2"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V3"},"children":["V3"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Change"},"children":["Change"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/reports/query"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/reports/query"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Version only."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom query using widget id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/reports/query/{widgetId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/reports/query/widget?widgetId={id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Breaking."]}," Id moves from path to query ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["and"]}," the path gains a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/widget"]}," segment."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Batch query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/reports/batchQuery"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/reports/batchQuery"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Version only."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch reporting engines"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/reports/engines"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/reports/engine"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Breaking."]}," Plural → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["singular"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch report names"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/reports/reports/{reportingEngineId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/reports/report?reportingEngineId={id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Breaking."]}," Doubled ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reports/reports"]}," collapses to singular ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["report"]},"; id moves from path to query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch custom metrics"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/reports/customMetric/{reportingEngineId}?reportNames={name}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/reports/custom-metric?reportingEngineId={id}&reportNames={name}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Breaking."]}," camelCase → ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["kebab-case"]},"; id moves from path to query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch metrics and dimensions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/reports/metadata/{reportingEngineId}?reportNames={name}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/reports/metadata?reportingEngineId={id}&reportNames={name}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Breaking."]}," Id moves from path to query."]}]}]}]}]}]},"headings":[{"value":"Reporting API V3 — Developer Guide","id":"reporting-api-v3--developer-guide","depth":1},{"value":"1. Overview","id":"1-overview","depth":2},{"value":"1.1 The four concepts you need","id":"11-the-four-concepts-you-need","depth":3},{"value":"1.2 Which query endpoint should I use?","id":"12-which-query-endpoint-should-i-use","depth":3},{"value":"1.3 The Generate API Payload workflow","id":"13-the-generate-api-payload-workflow","depth":3},{"value":"1.4 Prerequisites","id":"14-prerequisites","depth":3},{"value":"1.5 Conventions used in this guide","id":"15-conventions-used-in-this-guide","depth":3},{"value":"2. Base URLs and environments","id":"2-base-urls-and-environments","depth":2},{"value":"3. Authentication and common headers","id":"3-authentication-and-common-headers","depth":2},{"value":"Discovery endpoints","id":"discovery-endpoints","depth":1},{"value":"4. GET /reports/engine — List reporting engines","id":"4-get-reportsengine--list-reporting-engines","depth":2},{"value":"4.1 Parameters","id":"41-parameters","depth":3},{"value":"4.2 Example request","id":"42-example-request","depth":3},{"value":"4.3 Example response","id":"43-example-response","depth":3},{"value":"4.4 Reporting engines","id":"44-reporting-engines","depth":3},{"value":"5. GET /reports/report — List report names","id":"5-get-reportsreport--list-report-names","depth":2},{"value":"5.1 Parameters","id":"51-parameters","depth":3},{"value":"5.2 Example request","id":"52-example-request","depth":3},{"value":"5.3 Example response","id":"53-example-response","depth":3},{"value":"5.4 Response parameters","id":"54-response-parameters","depth":3},{"value":"6. GET /reports/metadata — Fetch metrics and dimensions","id":"6-get-reportsmetadata--fetch-metrics-and-dimensions","depth":2},{"value":"6.1 Parameters","id":"61-parameters","depth":3},{"value":"6.2 Example request","id":"62-example-request","depth":3},{"value":"6.3 Example response","id":"63-example-response","depth":3},{"value":"6.4 Response parameters","id":"64-response-parameters","depth":3},{"value":"6.5 Resolving a custom property to its UI label","id":"65-resolving-a-custom-property-to-its-ui-label","depth":3},{"value":"7. GET /reports/custom-metric — Fetch custom metrics","id":"7-get-reportscustom-metric--fetch-custom-metrics","depth":2},{"value":"7.1 Parameters","id":"71-parameters","depth":3},{"value":"7.2 Example request","id":"72-example-request","depth":3},{"value":"7.3 Example response","id":"73-example-response","depth":3},{"value":"7.4 Response parameters","id":"74-response-parameters","depth":3},{"value":"Query endpoints","id":"query-endpoints","depth":1},{"value":"8. POST /reports/query — Custom query","id":"8-post-reportsquery--custom-query","depth":2},{"value":"8.1 Parameters","id":"81-parameters","depth":3},{"value":"8.2 Example request","id":"82-example-request","depth":3},{"value":"8.3 Example response","id":"83-example-response","depth":3},{"value":"8.4 Response parameters","id":"84-response-parameters","depth":3},{"value":"9. POST /reports/query/widget — Custom query using widget id","id":"9-post-reportsquerywidget--custom-query-using-widget-id","depth":2},{"value":"9.1 Parameters","id":"91-parameters","depth":3},{"value":"9.2 Finding the widget id","id":"92-finding-the-widget-id","depth":3},{"value":"9.3 Request body fields","id":"93-request-body-fields","depth":3},{"value":"9.4 Example request","id":"94-example-request","depth":3},{"value":"9.5 Example response","id":"95-example-response","depth":3},{"value":"9.6 Response parameters","id":"96-response-parameters","depth":3},{"value":"10. POST /reports/batchQuery — Batch query","id":"10-post-reportsbatchquery--batch-query","depth":2},{"value":"10.1 Request body fields","id":"101-request-body-fields","depth":3},{"value":"10.2 Example request","id":"102-example-request","depth":3},{"value":"10.3 Example response","id":"103-example-response","depth":3},{"value":"10.4 Response parameters","id":"104-response-parameters","depth":3},{"value":"10.5 The additional object in batch payloads","id":"105-the-additional-object-in-batch-payloads","depth":3},{"value":"11.1 ReportRequest","id":"111-reportrequest","depth":3},{"value":"11.2 Filter_reporting","id":"112-filter_reporting","depth":3},{"value":"11.3 Group_reporting","id":"113-group_reporting","depth":3},{"value":"11.4 Projection_reporting","id":"114-projection_reporting","depth":3},{"value":"11.5 Sort_reporting","id":"115-sort_reporting","depth":3},{"value":"11.6 The additional object","id":"116-the-additional-object","depth":3},{"value":"11.7 Reference enums","id":"117-reference-enums","depth":3},{"value":"12. Response format and status codes","id":"12-response-format-and-status-codes","depth":2},{"value":"12.1 The envelope","id":"121-the-envelope","depth":3},{"value":"12.2 The jsonResponse toggle","id":"122-the-jsonresponse-toggle","depth":3},{"value":"12.4 Status codes","id":"124-status-codes","depth":3},{"value":"13. V2 → V3 migration","id":"13-v2--v3-migration","depth":2},{"value":"13.1 Endpoint mapping","id":"131-endpoint-mapping","depth":3}],"frontmatter":{"seo":{"title":"Reporting API V3 — Developer Guide"}},"lastModified":"2026-10-22T18:13:07.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/developer-guides-v3/reporting-api-v3-developer-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}