/api/reports/alias/:alias

Shows detailed information about the report with the specified alias.

Resource Information

Resource URL

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

HTTP Method

GET

Request Parameters

Parameters

Detail

Example

alias

Alias of the report to fetch.

publicreport

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
tabs

Array of tabs inside the report with following structure

NameDescription
nameName of the tab
viewsArray containing IDs of the views inside the tab
views

Array of views where each view has following structure:

Name
Description
idView identifier
nameView name
typeView type - please see list of supported values.
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
dateTimeDefinition

(Optional) Applied date and time definition with following structure:

NameDescription
timeSupportedBoolean flag indicating if time is supported.
timeInterval

(Optional) Time interval to filter values. Has following structure:

NameDescription
aggregatedBoolean flag indicating if values are aggregated.
aggregationTypeTime interval period - please see list of supported values.
interval

Interval definition with following structure:

NameDescription
typeInterval type - please see list of supported values.
fromInterval start value
toInterval end value
dateSupportedBoolean flag indicating if date is supported.
dateInterval

(Optional) Date interval to filter values. Has following structure:

NameDescription
aggregatedBoolean flag indicating if values are aggregated.
aggregationTypeDate interval period - please see list of supported values.
interval

Interval definition with following structure:

NameDescription
typeInterval type - please see list of supported values.
fromInterval start value
toInterval end value



filter

(Optional) Applied filter with following structure:

NameDescription
drilldown

Drilldown defined with attribute code and following structure:

NameDescription
opFilter operation type - please see list of supported values.
value/values
(Optional) Depends on selected "op". Contains value or values for 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/publicreport

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" : [ ]
  }
}
  • No labels