Jump to

• Request
• Response
• Examples

Get an analytics report

get

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

Request

Path Parameters

• id(required): integer
  The unique identifier of the analytics report definition.

Back to Top

Response

Default Response

Body ()

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: object analyticsReports-columns
  The columns in an analytics report.
• createdTime: string
  The date and time when the analytics report was created. This attribute is read-only.
• filters: object analyticsReports-filters
  The filters used for running an analytics report.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the analytics report definition.
• lookupName: string
  Maximum Length: 255

  The name used to look up the analytics report definition.
• name: string
  Maximum Length: 80

  The name of the report in the language of the current interface. This attribute is read-only.
• names: 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: 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":"9223372036854776000"
        },
        "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: 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: string
  Maximum Length: 349525

  The description of the column in the report.
• heading: 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

The filters used for running an analytics report.

Show Source

• attributes: object analyticsReports-filters-attributes
  The attributes associated with an analytics report filter.
• dataType: 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: string
  Maximum Length: 80

  Pattern: ^[^ ]*$

  The name of the filter.
• operator: 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: string
  Maximum Length: 80

  Pattern: ^[^ ]*$

  The prompt for the filter.
• values: array values
  The string representation of the values for the operator to apply. The right-hand side (RHS) of the filter value.

{
    "type":"object",
    "description":"The filters used for running an analytics report.",
    "properties":{
        "prompt":{
            "pattern":"^[^\n]*$",
            "type":"string",
            "description":"The prompt for the filter.",
            "maxLength":"80"
        },
        "name":{
            "pattern":"^[^\n]*$",
            "type":"string",
            "description":"The name of the filter.",
            "maxLength":"80"
        },
        "dataType":{
            "type":"object",
            "description":"The data type of the filter.",
            "$ref":"#/definitions/namedIDs-analyticsReports-filters-dataType"
        },
        "values":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"The string representation of the values for the operator to apply. The right-hand side (RHS) of the filter value.",
            "maxLength":"1048576"
        },
        "operator":{
            "type":"object",
            "description":"The operator used in the filter.",
            "$ref":"#/definitions/namedIDs-analyticsReports-filters-operator"
        },
        "attributes":{
            "type":"object",
            "description":"The attributes of the 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: string
  Maximum Length: 80

  The language-specific label text. The value cannot be null or empty.
• language: 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: integer
  Minimum Value: 0

  ID value
• lookupName: 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

The attributes associated with an analytics report filter.

Show Source

• editable: boolean
  Indicates whether the filter is editable. This attribute does not have a default value.
• required: boolean
  Indicates whether the filter is mandatory. This attribute does not have a default value.

{
    "type":"object",
    "description":"The attributes associated with an analytics report filter.",
    "properties":{
        "required":{
            "type":"boolean",
            "description":"Indicates whether the filter is mandatory. This attribute does not have a default value."
        },
        "editable":{
            "type":"boolean",
            "description":"Indicates whether the filter is editable. This attribute does not have a default value."
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: 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: integer
  Minimum Value: 0

  ID value
• lookupName: 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. The right-hand side (RHS) of the filter value.

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"The string representation of the values for the operator to apply. The right-hand side (RHS) of the filter value.",
    "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: integer
  Minimum Value: 0

  ID value
• lookupName: 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"
        }
    }
}

Back to Top

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

Back to Top