Run report

post

https://example.com/api/v3/reports/run

Run report by report ID or by specifying report definition.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

RunReportRequest is the argument of RunReport API.

calculate_facets

boolean

Whether or not to calculate facets.

date_range

object

DateRange represents a date range type - from an enum and if its custom / relative - the start and the end date.

default_chart_expanded

boolean

Optional: if report has chart -send default_chart_expanded be saved in user settings collection per report and user.

fetch_size

int32

The max amount of rows to return for pagination. Required if report query uses offset and fetch_size parameters.

job_type

string

enum

Defaults to UNDEFINED_JOB_TYPE

JobType - available export job types.

Allowed:

model_type

string

enum

Defaults to UNDEFINED_MODEL_TYPE

Allowed:

offset

int32

The amount to offset the rows by for pagination. Required if report query uses offset and fetch_size parameters.

report_definition

object

ReportDefinition encapsulates all data necessary for a report object.

report_id

string

Optional: the ID of the Report we wish to run (e.g. 000000000000000000000905).

runtime_parameter_list

array of objects

List of runtime parameter if needed.

runtime_parameter_list

time_zone

string

Optional: time zone.

use_quick_facets

boolean

Whether or not to calculate count.

without_limit

boolean

Whether or not to limit the results.

Responses

200A successful response.(streaming responses)

defaultAn unexpected error response.