Sign in

2faa857793e8

latestOpenAPI 3.0.12026-07-245277551.2 MB
Reports

Get report based on search results

Get reports filtered by different search criteria

Notes:

  • Rows are returned if title contains values (case-insensitive comparison)
  • The API returns 200 even if no results are found.
get/datainsights/v1.1/reports/search

Query parameters

offsetinteger

The difference between start of the data and the start of the response data

limitinteger
Example:5

The maximum number of results in the response

sort'id,asc' | 'id,desc' | 'title,asc' | 'title,desc' | 'description,asc' | 'description,desc' | 'dataset_id,asc' | 'dataset_id,desc' | 'folder_id,asc' | 'folder_id,desc' | 'user_id,asc' | 'user_id,desc' | 'updated_at,asc' | 'updated_at,desc'

Sort reports

idsinteger[]

Filter by Report IDs

titlestring

Filter by Report title

descriptionstring nullable

Filter by Report description

dataset_idsinteger[]

Filter by Dataset IDs

folder_idsstring

A comma-separated list of the Folder IDs that has reports. Maximum: 50 IDs.

tag_idsinteger[]

Tag IDs

user_idsinteger[]

Filter reports created by a user ID

search_termstring
Example:in-house

A text string to search for in any of the search column fields

search_columnsstring[]

Headers

X-PROPERTY-IDinteger required

Property id of the client

Response

OK

offsetinteger

The difference between start of the data and the start of the response data

limitinteger

The maximum number of results in the response

totalinteger

The total number of records

Example response

{
  "limit": 5,
  "total": 42,
  "reports": [
    {
      "title": "Report title",
      "description": "Report description",
      "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"
          }
        }
      ],
      "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'"
        }
      ],
      "comparisons": [
        {
          "name": "Range 1",
          "id": "range_1",
          "filters": {
            "and": [
              {
                "cdf": {
                  "type": "default",
                  "column": "credit_amount"
                }
              }
            ]
          }
        }
      ],
      "filters": {
        "and": [
          {
            "cdf": {
              "type": "default",
              "column": "credit_amount"
            }
          }
        ],
        "or": [
          {
            "cdf": {
              "type": "default",
              "column": "credit_amount"
            }
          }
        ]
      },
      "sort": [
        {
          "cdf": {
            "type": "default",
            "column": "credit_amount"
          },
          "direction": "asc"
        }
      ],
      "formats": {
        "date": "YYYY-MM-DD"
      },
      "type": "List",
      "tags": [
        {
          "name": "#Financial"
        }
      ],
      "schedule_ids": [
        1
      ],
      "custom_cdfs": [
        {
          "column": "full_address",
          "name": "Full address",
          "description": "CDF with the full address information",
          "kind": "String",
          "format": "currency"
        }
      ]
    }
  ]
}