Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
reports

Get report definition

Gets the definition (filters, grouping criteria, summarizing criteria, and sorting criteria) for the specified report.

get/reports/{reportId}/definition

Response

The report definition object.

Example response

{
  "filters": {
    "operator": "AND",
    "criteria": [
      {
        "column": {
          "title": "Primary Column",
          "type": "TEXT_NUMBER",
          "primary": true
        },
        "operator": "EQUAL",
        "values": [
          "Test"
        ]
      }
    ]
  },
  "groupingCriteria": [
    {
      "column": {
        "title": "Primary Column",
        "type": "TEXT_NUMBER",
        "primary": true
      },
      "sortingDirection": "ASCENDING",
      "isExpanded": true
    }
  ],
  "summarizingCriteria": [
    {
      "column": {
        "title": "Primary Column",
        "type": "TEXT_NUMBER",
        "primary": true
      },
      "aggregationType": "COUNT"
    }
  ],
  "sortingCriteria": [
    {
      "column": {
        "title": "Primary Column",
        "type": "TEXT_NUMBER",
        "primary": true
      },
      "sortingDirection": "ASCENDING"
    }
  ]
}