Examples

POST /api/report_templates/1007981727/generate
{
  "report_format": "json",
  "report_template": {}
}
200
[
  {
    "a": 1
  },
  {
    "a": 2
  }
]

Params

Param Name Description
location_id
Optional

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
Optional

Set the current organization context for the request

Validations:

  • Must be a Integer

id
Required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

input_values
Optional

Hash of input values where key is the name of input, value is the value for this input

Validations:

  • Must be a Hash

gzip
Optional

Compress the report uzing gzip

Validations:

  • Must be one of: true, false, 1, 0.

report_format
Optional

Report format, defaults to ‘csv’

Validations:

  • Must be one of: csv, json, yaml, html.