v1
latestOpenAPI 3.0.12026-07-245277551.2 MBChart
Search for a chart
get/datainsights/v1.1/charts/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' | 'kind,asc' | 'kind,desc' | 'created_at,asc' | 'created_at,desc' | 'updated_at,asc' | 'updated_at,desc'
Sort Charts
idsinteger[]
Chart IDs , delimited. For example ?ids=1,2,3
datasource_kind'report' | 'stock_report'
Example:stock_report
Datasource Kind
tag_idsinteger[]
Tag IDs , delimited. For example ?tag_ids=1,2,3
chart_kindstring[]
Chart Kinds, delimited
[ "bar" ]
dataset_idsinteger[]
Dataset IDs, delimited
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
Example response
{
"limit": 5,
"total": 42,
"charts": [
{
"datasource_kind": "stock_report",
"datasource_title": "My Report",
"datasource_description": "Detailed Report Description",
"title": "My cool new chart",
"kind": "bar",
"settings": {
"metrics": [
{
"cdf": {
"type": "default",
"column": "credit_amount"
},
"metric": "sum",
"kind": "line",
"axis": "left"
}
],
"stack": "normalized"
},
"categories": "\"Periods\"",
"metrics": [
{
"cdf": {
"type": "default",
"column": "credit_amount"
},
"metrics": [
"sum"
]
}
],
"created_at": "2022-01-01T00:00:00Z",
"updated_at": "2022-01-01T00:00:00Z"
}
]
}