Jump to

• Request
• Response

Empty statistics

get

https://{your_site_interface}/opa-hub/api/12.2.35/statistics

This operation will get an empty statistics response only containing related links.

Request

Query Parameters

• expand: string
  Comma separated list of named resources to expand, or "all" to expand all
• fields: string
  Comma separated list of fields to be returned
• links: string
  Comma separated list of links to be returned, or "none" to omit links
• q: string
  A JSON object for filtering matching property values within the collection

There's no request body for this operation.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

No statistics were retrieved.

Body ()

Root Schema : statistics

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/statistic"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object statistic

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/statistic"
    }
}

Nested Schema : statistic

Type: object

Show Source

• categoryTitle: string
  Read Only: true

  Category title for the series data.
• chartTitle: string
  Read Only: true

  Chart title for the series data.
• data: array data
  Read Only: true

  List of statistics data.
• includedActionTypes: array includedActionTypes
  The action types to include in the returned metric data. If not provided, includes a default set of actions as defined by the chosen metric.
• metricTitle: string
  Read Only: true

  Metric title for the series data.
• valueTitle: string
  Read Only: true

  Value title for the series data.

{
    "type":"object",
    "properties":{
        "chartTitle":{
            "type":"string",
            "description":"Chart title for the series data.",
            "readOnly":true
        },
        "metricTitle":{
            "type":"string",
            "description":"Metric title for the series data.",
            "readOnly":true
        },
        "valueTitle":{
            "type":"string",
            "description":"Value title for the series data.",
            "readOnly":true
        },
        "categoryTitle":{
            "type":"string",
            "description":"Category title for the series data.",
            "readOnly":true
        },
        "includedActionTypes":{
            "type":"array",
            "description":"The action types to include in the returned metric data. If not provided, includes a default set of actions as defined by the chosen metric.",
            "items":{
                "type":"string",
                "enum":[
                    "nonAgentInterviews",
                    "agentInterviews",
                    "allAssessedCases",
                    "batchAssessCases",
                    "answerServiceAPICalls",
                    "assessServiceAPICalls",
                    "referencedDecisionServiceCases",
                    "testServiceCases"
                ]
            }
        },
        "data":{
            "type":"array",
            "description":"List of statistics data.",
            "readOnly":true,
            "items":{
                "description":"An item in the statistics data.",
                "readOnly":true,
                "$ref":"#/components/schemas/statisticDataItem"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : data

Type: array

Read Only: true

List of statistics data.

Show Source

• Array of: object statisticDataItem

{
    "type":"array",
    "description":"List of statistics data.",
    "readOnly":true,
    "items":{
        "description":"An item in the statistics data.",
        "readOnly":true,
        "$ref":"#/components/schemas/statisticDataItem"
    }
}

Nested Schema : includedActionTypes

Type: array

The action types to include in the returned metric data. If not provided, includes a default set of actions as defined by the chosen metric.

Show Source

• Array of: string
  Allowed Values: [ "nonAgentInterviews", "agentInterviews", "allAssessedCases", "batchAssessCases", "answerServiceAPICalls", "assessServiceAPICalls", "referencedDecisionServiceCases", "testServiceCases" ]

{
    "type":"array",
    "description":"The action types to include in the returned metric data. If not provided, includes a default set of actions as defined by the chosen metric.",
    "items":{
        "type":"string",
        "enum":[
            "nonAgentInterviews",
            "agentInterviews",
            "allAssessedCases",
            "batchAssessCases",
            "answerServiceAPICalls",
            "assessServiceAPICalls",
            "referencedDecisionServiceCases",
            "testServiceCases"
        ]
    }
}

Nested Schema : statisticDataItem

Type: object

Show Source

• category: string
  The statistics data item category.
• group: string
  The statistics data item group.
• series: string
  The statistics data item series.
• value(required): number (double)
  The statistics data item value.

{
    "type":"object",
    "properties":{
        "value":{
            "type":"number",
            "format":"double",
            "description":"The statistics data item value."
        },
        "series":{
            "type":"string",
            "description":"The statistics data item series."
        },
        "category":{
            "type":"string",
            "description":"The statistics data item category."
        },
        "group":{
            "type":"string",
            "description":"The statistics data item group."
        }
    },
    "additionalProperties":false,
    "required":[
        "value"
    ]
}

Back to Top