Skip to content

Reporting

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.

Operations

Execute multiple reporting queries in one request.

Request

Security
bearerAuth and apiKeyAuth
Bodyapplication/jsonrequired
requestsobject
collateboolean
curl -i -X POST \
  https://dev-staging.sprinklr.com/_mock/apis/sprinklr-v3/reports/batchQuery \
  -H 'Authorization: Bearer <YOUR_Token_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Key: YOUR_API_KEY_HERE' \
  -d '{
    "requests": {
      "property1": {
        "report": "string",
        "reportingEngine": "string",
        "timeField": "string",
        "startTime": 0,
        "endTime": 0,
        "timeZone": "string",
        "page": 0,
        "pageSize": 0,
        "filters": [
          {
            "dimensionName": "string",
            "filterType": "string",
            "values": [
              {}
            ],
            "details": {
              "property1": {},
              "property2": {}
            }
          }
        ],
        "groupBys": [
          {
            "heading": "string",
            "dimensionName": "string",
            "groupType": "string",
            "details": {
              "property1": {},
              "property2": {}
            },
            "namedFilters": {
              "property1": [
                {
                  "values": [],
                  "details": {}
                }
              ],
              "property2": [
                {
                  "values": [],
                  "details": {}
                }
              ]
            }
          }
        ],
        "projections": [
          {
            "heading": "string",
            "measurementName": "string",
            "aggregateFunction": "string",
            "details": {
              "property1": {},
              "property2": {}
            }
          }
        ],
        "projectionDecorations": [
          "string"
        ],
        "projectionFilters": [
          {
            "dimensionName": "string",
            "filterType": "string",
            "values": [
              {}
            ],
            "details": {
              "property1": {},
              "property2": {}
            }
          }
        ],
        "sorts": [
          {
            "heading": "string",
            "order": "string"
          }
        ],
        "streamRequestInfo": {
          "streamFields": [
            {}
          ],
          "name": "string",
          "childName": "string",
          "details": {
            "property1": {},
            "property2": {}
          }
        },
        "additional": {
          "property1": "string",
          "property2": "string"
        },
        "skipResolve": true,
        "jsonResponse": true
      },
      "property2": {
        "report": "string",
        "reportingEngine": "string",
        "timeField": "string",
        "startTime": 0,
        "endTime": 0,
        "timeZone": "string",
        "page": 0,
        "pageSize": 0,
        "filters": [
          {
            "dimensionName": "string",
            "filterType": "string",
            "values": [
              {}
            ],
            "details": {
              "property1": {},
              "property2": {}
            }
          }
        ],
        "groupBys": [
          {
            "heading": "string",
            "dimensionName": "string",
            "groupType": "string",
            "details": {
              "property1": {},
              "property2": {}
            },
            "namedFilters": {
              "property1": [
                {
                  "values": [],
                  "details": {}
                }
              ],
              "property2": [
                {
                  "values": [],
                  "details": {}
                }
              ]
            }
          }
        ],
        "projections": [
          {
            "heading": "string",
            "measurementName": "string",
            "aggregateFunction": "string",
            "details": {
              "property1": {},
              "property2": {}
            }
          }
        ],
        "projectionDecorations": [
          "string"
        ],
        "projectionFilters": [
          {
            "dimensionName": "string",
            "filterType": "string",
            "values": [
              {}
            ],
            "details": {
              "property1": {},
              "property2": {}
            }
          }
        ],
        "sorts": [
          {
            "heading": "string",
            "order": "string"
          }
        ],
        "streamRequestInfo": {
          "streamFields": [
            {}
          ],
          "name": "string",
          "childName": "string",
          "details": {
            "property1": {},
            "property2": {}
          }
        },
        "additional": {
          "property1": "string",
          "property2": "string"
        },
        "skipResolve": true,
        "jsonResponse": true
      }
    },
    "collate": true
  }'

Responses

Success

Bodyapplication/json
dataobject
errorsArray of objects(Error)
metadataobject(ResponseMetadata)
Response
{
  "data": {},
  "errors": [
    { … }
  ],
  "metadata": {}
}