You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 20 Next »

/api/reports/:id

Shows detailed information about the report with the specified ID.

Resource Information

Resource URL

https://service.belladati.com/api/reports/:id

HTTP Method

GET

Request Parameters

Parameters

Detail

Example

id

ID of the report to fetch. You can find the ID in the response to /api/reports.

123

Response Structure

JSON response contains one JSON object with following elements:

Name
Description
idReport identifier
nameReport name
localizationLocalization object that contains key-value pairs, where key is code of supported language and value is localized report name.
descriptionReport description
ownerOwner's full name
lastChangeDate and time of last change
views

Array of views where each view has following structure:

Name
Description
idView identifier
nameView name
typeView type
localizationLocalization object that contains key-value pairs, where key is code of supported language and value is localized view name.
isFavouriteBoolean flag indicating if view is marked as favourite
dateTimeDefinitionApplied date and time definition
filterApplied filter
dataSet

Source data set

Name
Description
idData set identifier
nameData set name
descriptionData set description
ownerOwner's full name
lastChangeDate and time of last change
dateSupportedBoolean flag indicating if date is supported
timeSupportedBoolean flag indicating if time is supported
drilldownAttributesArray of drilldown attributes

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",
  "lastChange" : "Tue, 22 May 2012 17:16:31 GMT",
  "views" : [
    {
      "id" : 24530,
      "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" : [ ]
  }
}
  • No labels