Retrieve an instance of analyticsReports

get

/services/rest/connect/latest/analyticsReports/{id}

Request

Path Parameters

Response

Supported Media Types

Default Response

Body ()
An Analytics Report Definition
Root Schema : analyticsReports
Type: object
An Analytics Report Definition
Show Source
Nested Schema : analyticsReports-columns
Type: object
An Analytics Report Column Definition
Show Source
Nested Schema : analyticsReports-filters
Type: object
An Analytics Report Filter Definition
Show Source
Nested Schema : analyticsReports-names
Type: object
Strings that are language-specific, allowing localization of fields. Like the Label class, but the label text cannot be empty or null. Labels will be assembled in a list that is associated with one particular text field
Show Source
Nested Schema : namedIDs-analyticsReports-columns-dataType
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : analyticsReports-filters-attributes
Type: object
Attributes associated with an AnalyticsReportFilter
Show Source
Nested Schema : namedIDs-analyticsReports-filters-dataType
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-analyticsReports-filters-operator
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : values
Type: array
Maximum Length: 1048576
The string representation of the values for the Operator to apply
Show Source
Nested Schema : namedIDs-analyticsReports-names-language
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source

Examples

Use GET with the following syntax to retrieve a specific report:

https://your_site_interface/services/rest/connect/version/analyticsReports/report_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/analyticsReports/5

Response body example

{
    "id": 5,
    "lookupName": "Answers Viewed by Category",
    "createdTime": "2007-02-01T08:00:00.000Z",
    "updatedTime": "2007-02-01T08:00:00.000Z",
    "columns": {
        "links": [
            {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/analyticsReports/5/columns"
            }
        ]
    },
    "filters": {
        "links": [
            {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/analyticsReports/5/filters"
            }
        ]
    },
    "name": "Answers Viewed by Category",
    "names": {
        "links": [
            {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/analyticsReports/5/names"
            }
        ]
    },
    "links": [
        {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/analyticsReports/5"
        },
        {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/analyticsReports/5"
        },
        {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/analyticsReports",
        "mediaType": "application/schema+json"
        }
    ]
}