/api/reports/:id
Shows detailed information about the report with the specified ID.
Resource Information
Resource URL | |
---|---|
HTTP Method |
|
Request Parameters
Parameters | Detail | Example |
---|---|---|
| ID of the report to fetch. You can find the ID in the response to | 123 |
Response Structure
JSON response contains one JSON object with following elements:
Name | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | Report identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | Report name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
localization | Localization object that contains key-value pairs, where key is code of supported language and value is localized report name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | Report description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
owner | Owner's full name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
lastChange | Date and time of last change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tabs | Array of tabs inside the report with following structure
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
views | Array of views where each view has following structure:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dataSet | Source data set
|
Sample Request / Response
Using curl
:
curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/reports/123
The JSON format response:
{ "id" : 123, "name" : "My Report", "localization" : { "de" : "Der Report" }, "description" : "This is a report description", "owner" : "John Smith", "tabs": [ { "name": "First tab", "views": [ "l2nuOY1ocA" ] }, { "name": "Second tab", "views": [ "wK4g3gmezs" ] } ], "lastChange" : "Tue, 22 May 2012 17:16:31 GMT", "views" : [ { "id" : 302-xB0Klm6c1L, "type" : "chart", "name" : "My View name", "localization" : { "de" : "Der lokalisierte Name" }, "isFavourite" : false, "dateTimeDefinition" : { "timeSupported" : true, "dateSupported" : true, "timeInterval" : { "aggregationType" : "SECOND", "interval" : { "from" : { "hour" : "13", "minute" : "38", "second" : "0" }, "to" : { "hour" : "21", "minute" : "48", "second" : "0" }, "type" : "absolute" }, "aggregated" : false }, "dateInterval" : { "aggregationType" : "DAY", "interval" : { "from" : { "month" : "8", "year" : "2012", "day" : "7" }, "to" : { "month" : "7", "year" : "2015", "day" : "14" }, "type" : "absolute" } } }, "filter": { "drilldown": { "L_USER": { "values": [ "john" ], "op": "IN" } } } } ], "dataSet" : { "id" : 1234, "name" : "Data set name", "description" : "This is a data set description", "owner" : "John Smith", "lastChange" : "Thu, 08 Oct 2015 11:43:40 GMT", "timeSupported" : true, "dateSupported" : true, "drilldownAttributes" : [ ] } }