Jump to

• Request
• Response
• Examples

Create an analytics report result

post

/services/rest/connect/v1.4/analyticsReportResults

Request

Body ()

Root Schema : schema

Type: object

Show Source

• filters: object analyticsReports-filters
  The filters used for running an analytics report.
• id(required): integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the analytics report definition.
• limit: integer
  Minimum Value: 1

  Maximum Value: 10000

  The maximum number of rows to be retrieved in the report.
• lookupName: string
  Maximum Length: 255

  The name used to look up the analytics report definition.
• offset: integer
  Minimum Value: 0

  The starting row position of the resource collection. For example, if you set an offset of 8, the report will skip the first eight rows, and include the rows from row 9 in the report.

{
    "required":[
        "id"
    ],
    "properties":{
        "offset":{
            "minimum":"0",
            "type":"integer",
            "description":"The starting row position of the resource collection. For example, if you set an offset of 8, the report will skip the first eight rows, and include the rows from row 9 in the report."
        },
        "limit":{
            "minimum":"1",
            "type":"integer",
            "maximum":"10000",
            "description":"The maximum number of rows to be retrieved in the report."
        },
        "id":{
            "$ref":"#/definitions/analyticsReports-id"
        },
        "filters":{
            "$ref":"#/definitions/analyticsReports-filters"
        },
        "lookupName":{
            "$ref":"#/definitions/analyticsReports-lookupName"
        }
    }
}

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

Back to Top

Response

Default Response

Back to Top

Examples

Use POST with the following syntax to run a report:

https://your_site_interface/services/rest/connect/version/analyticsReportResults

Request URI example

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

Request body example

Include the report ID or LookupName in the request body. This example uses the LookupName.

{
"lookupName": "Last Updated by Status"
}

Response body example

{
    "count": 1,
    "name": "Last Updated by Status",
    columnNames": [
        "Status",
        "Incidents",
        "Average Time Since Last Response"
    ],
    rows": [
        [
        "Unresolved",
        "46",
        null
        ]
    ],
    "links": [
        {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/analyticsReportResults"
        },
        {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/analyticsReportResults"
        },
        {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/analyticsReportResults",
        "mediaType": "application/schema+json"
        }
    ]
}

Back to Top