Jump to

• Request
• Response

Retrieve statistics

post

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

This operation will retrieve statistics for the given definition.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object statisticPost

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

Nested Schema : statisticPost

Type: object

Show Source

• deploymentSeries: deploymentSeries
• deploymentVersionSeries: array deploymentVersionSeries
  The list of deployment versions.
• groupBy: string
  Allowed Values: [ "hour", "day", "month", "screenVisit", "screenName" ]

  The granularity of the metric data to be retrieved. If not provided, a default grouping is provided as defined by the chosen metric.
• 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.
• metric(required): string
  Allowed Values: [ "assessmentRateByDate", "deploymentAgentsByDate", "deploymentAssessmentsByDate", "deploymentInteractionByDate", "deploymentSessionsByDate", "interviewsByDuration", "interviewsByLength", "interviewsByScreenDuration", "interviewsByScreenState" ]

  The metric for which to retrieve data.
• timePeriod: string
  Default Value: last24Hours

  Allowed Values: [ "last24Hours", "last48Hours", "last72Hours", "last7Days", "last14Days", "last30Days", "last1Year", "last2Years" ]

  The time period for which to retrieve metric data. If not provided, defaults to last24Hours.

{
    "type":"object",
    "properties":{
        "metric":{
            "type":"string",
            "description":"The metric for which to retrieve data.",
            "writeOnly":true,
            "enum":[
                "assessmentRateByDate",
                "deploymentAgentsByDate",
                "deploymentAssessmentsByDate",
                "deploymentInteractionByDate",
                "deploymentSessionsByDate",
                "interviewsByDuration",
                "interviewsByLength",
                "interviewsByScreenDuration",
                "interviewsByScreenState"
            ]
        },
        "timePeriod":{
            "type":"string",
            "description":"The time period for which to retrieve metric data. If not provided, defaults to last24Hours.",
            "writeOnly":true,
            "enum":[
                "last24Hours",
                "last48Hours",
                "last72Hours",
                "last7Days",
                "last14Days",
                "last30Days",
                "last1Year",
                "last2Years"
            ],
            "default":"last24Hours"
        },
        "groupBy":{
            "type":"string",
            "description":"The granularity of the metric data to be retrieved. If not provided, a default grouping is provided as defined by the chosen metric.",
            "writeOnly":true,
            "enum":[
                "hour",
                "day",
                "month",
                "screenVisit",
                "screenName"
            ]
        },
        "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"
                ]
            }
        },
        "deploymentSeries":{
            "oneOf":[
                {
                    "type":"string",
                    "description":"Where all deployments should be used.",
                    "enum":[
                        "all"
                    ],
                    "writeOnly":true
                },
                {
                    "type":"array",
                    "description":"The list of deployment names.",
                    "items":{
                        "type":"string"
                    },
                    "writeOnly":true
                }
            ],
            "writeOnly":true
        },
        "deploymentVersionSeries":{
            "type":"array",
            "description":"The list of deployment versions.",
            "items":{
                "oneOf":[
                    {
                        "type":"object",
                        "properties":{
                            "deploymentName":{
                                "type":"string",
                                "description":"The deployment name of the deployment version for the series.",
                                "writeOnly":true
                            },
                            "deploymentState":{
                                "type":"string",
                                "description":"The deployment state, one of \"active\" or \"all\".",
                                "writeOnly":true,
                                "enum":[
                                    "active",
                                    "all"
                                ]
                            }
                        },
                        "required":[
                            "deploymentName",
                            "deploymentState"
                        ]
                    },
                    {
                        "type":"object",
                        "properties":{
                            "deploymentName":{
                                "type":"string",
                                "description":"The deployment name of the deployment version for the series.",
                                "writeOnly":true
                            },
                            "deploymentVersion":{
                                "type":"integer",
                                "format":"int64",
                                "description":"The deployment version.",
                                "writeOnly":true
                            }
                        },
                        "required":[
                            "deploymentName",
                            "deploymentVersion"
                        ]
                    }
                ]
            },
            "writeOnly":true
        }
    },
    "additionalProperties":false,
    "required":[
        "metric"
    ]
}

Nested Schema : deploymentSeries

Match One Schema

Show Source

• string
  Allowed Values: [ "all" ]

  Where all deployments should be used.
• array deploymentSeries-oneOf[1]
  The list of deployment names.

{
    "oneOf":[
        {
            "type":"string",
            "description":"Where all deployments should be used.",
            "enum":[
                "all"
            ],
            "writeOnly":true
        },
        {
            "type":"array",
            "description":"The list of deployment names.",
            "items":{
                "type":"string"
            },
            "writeOnly":true
        }
    ],
    "writeOnly":true
}

Nested Schema : deploymentVersionSeries

Type: array

The list of deployment versions.

Show Source

• Array of: items

{
    "type":"array",
    "description":"The list of deployment versions.",
    "items":{
        "oneOf":[
            {
                "type":"object",
                "properties":{
                    "deploymentName":{
                        "type":"string",
                        "description":"The deployment name of the deployment version for the series.",
                        "writeOnly":true
                    },
                    "deploymentState":{
                        "type":"string",
                        "description":"The deployment state, one of \"active\" or \"all\".",
                        "writeOnly":true,
                        "enum":[
                            "active",
                            "all"
                        ]
                    }
                },
                "required":[
                    "deploymentName",
                    "deploymentState"
                ]
            },
            {
                "type":"object",
                "properties":{
                    "deploymentName":{
                        "type":"string",
                        "description":"The deployment name of the deployment version for the series.",
                        "writeOnly":true
                    },
                    "deploymentVersion":{
                        "type":"integer",
                        "format":"int64",
                        "description":"The deployment version.",
                        "writeOnly":true
                    }
                },
                "required":[
                    "deploymentName",
                    "deploymentVersion"
                ]
            }
        ]
    },
    "writeOnly":true
}

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 : deploymentSeries-oneOf[1]

Type: array

The list of deployment names.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of deployment names.",
    "items":{
        "type":"string"
    },
    "writeOnly":true
}

Nested Schema : items

Match One Schema

Show Source

• object items-oneOf[0]
• object items-oneOf[1]

{
    "oneOf":[
        {
            "type":"object",
            "properties":{
                "deploymentName":{
                    "type":"string",
                    "description":"The deployment name of the deployment version for the series.",
                    "writeOnly":true
                },
                "deploymentState":{
                    "type":"string",
                    "description":"The deployment state, one of \"active\" or \"all\".",
                    "writeOnly":true,
                    "enum":[
                        "active",
                        "all"
                    ]
                }
            },
            "required":[
                "deploymentName",
                "deploymentState"
            ]
        },
        {
            "type":"object",
            "properties":{
                "deploymentName":{
                    "type":"string",
                    "description":"The deployment name of the deployment version for the series.",
                    "writeOnly":true
                },
                "deploymentVersion":{
                    "type":"integer",
                    "format":"int64",
                    "description":"The deployment version.",
                    "writeOnly":true
                }
            },
            "required":[
                "deploymentName",
                "deploymentVersion"
            ]
        }
    ]
}

Nested Schema : items-oneOf[0]

Type: object

Show Source

• deploymentName(required): string
  The deployment name of the deployment version for the series.
• deploymentState(required): string
  Allowed Values: [ "active", "all" ]

  The deployment state, one of "active" or "all".

{
    "type":"object",
    "properties":{
        "deploymentName":{
            "type":"string",
            "description":"The deployment name of the deployment version for the series.",
            "writeOnly":true
        },
        "deploymentState":{
            "type":"string",
            "description":"The deployment state, one of \"active\" or \"all\".",
            "writeOnly":true,
            "enum":[
                "active",
                "all"
            ]
        }
    },
    "required":[
        "deploymentName",
        "deploymentState"
    ]
}

Nested Schema : items-oneOf[1]

Type: object

Show Source

• deploymentName(required): string
  The deployment name of the deployment version for the series.
• deploymentVersion(required): integer (int64)
  The deployment version.

{
    "type":"object",
    "properties":{
        "deploymentName":{
            "type":"string",
            "description":"The deployment name of the deployment version for the series.",
            "writeOnly":true
        },
        "deploymentVersion":{
            "type":"integer",
            "format":"int64",
            "description":"The deployment version.",
            "writeOnly":true
        }
    },
    "required":[
        "deploymentName",
        "deploymentVersion"
    ]
}

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

The statistics were successfully 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"
    ]
}

Links

GetDeploymentByName

Operation: https://{your_site_interface}/opa/hub/api/12.2.35/deployments/{deployment/name}

Parameters:

• deployment-name: $request.body#/deploymentSeries[0]

The deploymentName from the request can be used as the deployment-name parameter in /deployments/{deployment-name}

GetDeploymentVersionByNameAndVersion

Operation: https://{your_site_interface}/opa/hub/api/12.2.35/deployments/{deployment/name}/versions/{deployment/version/versionNo}

Parameters:

• deployment-name: $request.body#/deploymentVersionSeries[0]/deploymentName
• deployment-version-versionNo: $request.body#/deploymentVersionSeries[0]/deploymentVersion

The deploymentName and versions parameters from the request can be used as the deployment-name and deployment-version-versionNo parameters in /deployments/{deployment-name}/versions/{deployment-version-versionNo}

400 Response

The request could not be processed because it contains missing or invalid information.

Back to Top