REST API for Oracle B2C Service

Get an analytics report

get

/services/rest/connect/v1.4/analyticsReports/{id}

Request

Path Parameters

id: integer

The unique identifier of the analytics report definition.

Response

Default Response

Root Schema : analyticsReports

Type: object

The analytics report definition that provides descriptions of a report's output columns, search criteria, and other components.

Show Source

columns(optional): object analyticsReports-columns

The columns in an analytics report.
createdTime(optional): string

The date and time when the analytics report was created. This attribute is read-only.
filters(optional): object analyticsReports-filters

An Analytics Report Filter Definition
id(optional): integer

Minimum Value: 1

Maximum Value: 9.223372036854776E18

The unique identifier of the analytics report definition.
lookupName(optional): string

Maximum Length: 255

The name used to look up the analytics report definition.
name(optional): string

Maximum Length: 80

The name of the report in the language of the current interface. This attribute is read-only.
names(optional): object analyticsReports-names

The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
updatedTime(optional): string

The date and time when the analytics report was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The analytics report definition that provides descriptions of a report's output columns, search criteria, and other components.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the analytics report was last updated. This attribute is read-only."
        },
        "name":{
            "type":"string",
            "description":"The name of the report in the language of the current interface. This attribute is read-only.",
            "maxLength":80
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the analytics report definition.",
            "maxLength":255
        },
        "names":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The list of language-specific display names.",
            "$ref":"#/definitions/analyticsReports-names"
        },
        "filters":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The filters defined on the report.",
            "$ref":"#/definitions/analyticsReports-filters"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the analytics report was created. This attribute is read-only."
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the analytics report definition.",
            "maximum":9.223372036854776E18
        },
        "columns":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The columns defined in the report.",
            "$ref":"#/definitions/analyticsReports-columns"
        }
    }
}

Nested Schema : analyticsReports-columns

Type: object

The columns in an analytics report.

Show Source

dataType(optional): object namedIDs-analyticsReports-columns-dataType

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.
description(optional): string

Maximum Length: 349525

The description of the column in the report.
heading(optional): string

Maximum Length: 349525

The column heading in the report.

{
    "type":"object",
    "description":"The columns in an analytics report.",
    "properties":{
        "dataType":{
            "type":"object",
            "description":"The data type of the column.",
            "$ref":"#/definitions/namedIDs-analyticsReports-columns-dataType"
        },
        "description":{
            "type":"string",
            "description":"The description of the column in the report.",
            "maxLength":349525
        },
        "heading":{
            "type":"string",
            "description":"The column heading in the report.",
            "maxLength":349525
        }
    }
}

Nested Schema : analyticsReports-filters

Type: object

An Analytics Report Filter Definition

Show Source

attributes(optional): object analyticsReports-filters-attributes

Attributes associated with an AnalyticsReportFilter
dataType(optional): object namedIDs-analyticsReports-filters-dataType

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.
name(optional): string

Maximum Length: 80

The filter name
operator(optional): object namedIDs-analyticsReports-filters-operator

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.
prompt(optional): string

Maximum Length: 80

The prompt for this filter
values(optional): array values

The string representation of the values for the Operator to apply

{
    "type":"object",
    "description":"An Analytics Report Filter Definition",
    "properties":{
        "prompt":{
            "type":"string",
            "description":"The prompt for this filter",
            "maxLength":80
        },
        "name":{
            "type":"string",
            "description":"The filter name",
            "maxLength":80
        },
        "dataType":{
            "type":"object",
            "description":"The filter data type",
            "$ref":"#/definitions/namedIDs-analyticsReports-filters-dataType"
        },
        "values":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"The string representation of the values for the Operator to apply",
            "maxLength":1048576
        },
        "operator":{
            "type":"object",
            "description":"The operator",
            "$ref":"#/definitions/namedIDs-analyticsReports-filters-operator"
        },
        "attributes":{
            "type":"object",
            "description":"attributes of this filter",
            "$ref":"#/definitions/analyticsReports-filters-attributes"
        }
    }
}

Nested Schema : analyticsReports-names

Type: object

The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.

Show Source

labelText(optional): string

Maximum Length: 80

The language-specific label text. The value cannot be null or empty.
language(optional): object namedIDs-analyticsReports-names-language

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.

{
    "type":"object",
    "description":"The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.",
    "properties":{
        "labelText":{
            "type":"string",
            "description":"The language-specific label text. The value cannot be null or empty.",
            "maxLength":80
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-analyticsReports-names-language"
        }
    }
}

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

id(optional): integer

Minimum Value: 0

ID value
lookupName(optional): string

Maximum Length: 255

Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : analyticsReports-filters-attributes

Type: object

Attributes associated with an AnalyticsReportFilter

Show Source

editable(optional): boolean

Is this filter editable?
required(optional): boolean

Is this filter required?

{
    "type":"object",
    "description":"Attributes associated with an AnalyticsReportFilter",
    "properties":{
        "required":{
            "type":"boolean",
            "description":"Is this filter required?"
        },
        "editable":{
            "type":"boolean",
            "description":"Is this filter editable?"
        }
    }
}

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

id(optional): integer

Minimum Value: 0

ID value
lookupName(optional): string

Maximum Length: 255

Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

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

id(optional): integer

Minimum Value: 0

ID value
lookupName(optional): string

Maximum Length: 255

Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : values

Type: array

Maximum Length: 1048576

The string representation of the values for the Operator to apply

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"The string representation of the values for the Operator to apply",
    "maxLength":1048576
}

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

id(optional): integer

Minimum Value: 0

ID value
lookupName(optional): string

Maximum Length: 255

Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

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"
        }
    ]
}