Reports

Query report summary

Query report summary from a report that is not created

Mode:

Preview: 100 Records
Run: 12000 Records

Based on the report type sent in the request, the data structure returned may have multiple formats.

Types

List

{
    ...
    "columns": ...
    "settings": {
        ...
        "totals": false,
        "transpose": false,
    }
}

List (Totals)

{
    ...
    "columns": ...
    "settings": {
        ...
        "totals": true,
        "transpose": false,

    }
}

PeriodList

{
    ...
    "columns": ...
    "periods": ...
    "settings": {
        ...
        "totals": false,
        "transpose": true|false,
    }
}

Summary

{
    ...
    "columns": ...
    "group_rows": ...
    "settings": {
        ...
        "totals": false,
        "transpose": true|false,

    }
}

Summary (Totals)

{
    ...
    "columns": ...
    "group_rows": ...
    "settings": {
        ...
        "totals": true
        "transpose: true|false,
    }
}

PeriodSummary

{
    ...
    "columns": ...
    "group_rows": ...
    "periods": ...
    "settings": {
        ...
        "totals": false,
        "transpose": true|false,
    }
}

Pivot

{
    ...
    "columns": ...
    "group_rows": ...
    "group_columns": ...
    "settings": {
        ...
        "totals": false,
        "transpose": true|false
    }
}

Pivot (Totals)

{
    ...
    "columns": ...
    "group_rows": ...
    "group_columns": ...
    "settings": {
        ...
        "totals": true,
        "transpose": true|false,
    }
}

Data

Type	Headers	Index	Records	Group Rows	Group Columns	Totals	Periods	Transpose
List	Yes	No	Yes	No	No	No	No	No
List (Totals)	Yes	No	Yes	No	No	Yes	No	No
PeriodList	Yes	Yes	Yes	No	No	No	Yes	Yes
Summary	Yes	Yes	Yes	Yes	No	No	No	Yes
Summary (Details)	Yes	Yes	Yes	Yes	No	Yes	No	No
Summary (Totals)	Yes	Yes	Yes	Yes	No	Yes	No	Yes
PeriodSummary	Yes	Yes	Yes	Yes	No	No	Yes	Yes
Pivot	Yes	Yes	Yes	Yes	Yes	No	No	Yes
Pivot (Totals)	Yes	Yes	Yes	Yes	Yes	Yes	No	Yes

post/datainsights/v1.1/reports/query/summary

Request

The document declares no server URL.
Auth
HTTP bearer

Query parameters

format'raw' | 'formatted'

Example:formatted

Select the format of the numbers in the records. The "raw" values are sent unmodified from the database. The "formatted" records as are cast to a string. Currency type CDFs are defined in the property settings and other numbers are formatted with commas to separate every third digit and a decimal to separate the fractional portion.

mode'Preview' | 'Run' required

Example:Preview

Select the mode to limit the amount of records. Preview has a limit of 100 records, and run has a limit 12,000 records

Headers

X-PROPERTY-IDinteger required

Property id of the client

Request body

property_idsinteger[] required

Report property ids

dataset_id1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 required

Dataset id

Example request

{
  "dataset_id": 1,
  "columns": [
    {
      "cdf": {
        "type": "default",
        "column": "credit_amount"
      },
      "metrics": [
        "sum"
      ]
    }
  ],
  "group_rows": [
    {
      "cdf": {
        "type": "default",
        "column": "credit_amount"
      }
    }
  ],
  "group_columns": [
    {
      "cdf": {
        "type": "default",
        "column": "credit_amount"
      }
    }
  ],
  "custom_cdfs": [
    {
      "column": "full_address",
      "name": "Full address",
      "description": "CDF with the full address information",
      "kind": "String",
      "format": "currency"
    }
  ],
  "filters": {
    "and": [
      {
        "cdf": {
          "type": "default",
          "column": "credit_amount"
        }
      }
    ],
    "or": [
      {
        "cdf": {
          "type": "default",
          "column": "credit_amount"
        }
      }
    ]
  },
  "sort": [
    {
      "cdf": {
        "type": "default",
        "column": "credit_amount"
      },
      "direction": "asc"
    }
  ],
  "periods": [
    {
      "cdf": {
        "type": "default",
        "column": "credit_amount"
      },
      "name": "Month-To-Date",
      "id": "start_of_last_year_to_today",
      "start": "'2014-12-22T03:12:58'|'start_current_year'",
      "end": "'2014-12-22T03:12:58'|'today'"
    }
  ],
  "formats": {
    "date": "YYYY-MM-DD"
  },
  "comparisons": [
    {
      "name": "Range 1",
      "id": "range_1",
      "filters": {
        "and": [
          {
            "cdf": {
              "type": "default",
              "column": "credit_amount"
            }
          }
        ]
      }
    }
  ]
}

Response

totalinteger required

Total records on the report

metricsobject required

Dictionary of metric columns

Example response

{
  "total": 100
}

Changes

No recorded changes to this operation across all 1 revision of this API.