API Reference

Update report by id

put
https://example.com/datainsights/v1.1/stock_reports/

Update a single report.

Note: The API may throw a HTTP 404 if there are no reports found with a given id.

The API returns a 200 OK if the update was successful.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

Stock report id of the resource

Body Params
string
required
length between 1 and 100

Report title

string | null

Report description

integer
enum
required

Dataset id

columns
array of objects
required
length ≥ 1

Report columns

columns*
group_rows
array of objects | null
Defaults to null

Report group rows

group_rows
group_columns
array of objects | null
Defaults to null

Report group columns

group_columns
periods
array of objects | null
Defaults to null

Periods to compare

periods
comparisons
array of objects | null
Defaults to null

A list of up to 5 Comparisons, each containing 'name' and 'filters' properties. The 'filters' are the same structure as those in report.filters.

comparisons
filters
object | null

Report filters

sort
array of objects | null
Defaults to null

Report sort

sort
settings
object | null

Report settings

formats
object | null

Formatting options of the report

property_ids
array of integers
length ≥ 1

Report property ids

property_ids
custom_cdfs
array of objects | null

Report custom cdfs

custom_cdfs
boolean

Published status of the report

rules
object
Headers
integer
required
≥ 1

Property id of the client

Responses

Updated 21 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 21 days ago