Metrics and reports

Measuring use of video call enables you to keep track of adoption and performance.

Enterprise Id can be found on your Apizee console or by API at /api/v3/users/me (authenticated).

Get tickets report for an enterprise

Endpoint: GET /api/v3/enterprises/{enterpriseId}/tickets/report Retrieve a consolidated report of all tickets for a given enterprise. The report includes aggregated metrics, grouping information, agent activity, and ticket state distribution.

When to use:

• Generating activity reports for a specific customer account.

• Building dashboards with key performance indicators (KPIs) for support sessions.

• Monitoring agent workload and ticket lifecycle distribution.

Get tickets report for enterprise

get

https://cloud.apizee.comhttps://hds.apizee.com

/api/v3/enterprises/{enterpriseId}/tickets/report

Authorizations

access_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

enterpriseIdintegerRequired

Id of the enterprise

Query parameters

startTimestringRequired

Start date (2021-12-17 | 2021-12-17 00:00:00 | 1639581400)

endTimestringRequired

End date (2021-12-17 | 2021-12-17 00:00:00 | 1639581400)

userIdintegerOptional

Filter on a specific user

groupIdintegerOptional

Filter on a specific user group

withTrashedbooleanOptional

Include deleted tickets

Responses

200

Good case

application/json

Responseany

400

Bad Request

application/json

401

Authentication Failure

application/json

get

/api/v3/enterprises/{enterpriseId}/tickets/report

HTTPcURLJavaScriptPython

GET /api/v3/enterprises/{enterpriseId}/tickets/report?startTime=text&endTime=text HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "metrics": {
      "nb_ticket": 8,
      "total_answered": 0,
      "total_nb_invitation": 0,
      "total_nb_call": 0,
      "total_duration": 0,
      "total_nb_photo": 0,
      "total_nb_video": 0
    },
    "groups": [
      {
        "value": 8,
        "label": "Default"
      }
    ],
    "agents": [
      {
        "value": 7,
        "label": "Agent 1"
      },
      {
        "value": 1,
        "label": "Agent 2"
      }
    ],
    "states": [
      {
        "value": 4,
        "label": "invited"
      },
      {
        "value": 2,
        "label": "inprogress"
      },
      {
        "value": 2,
        "label": "done"
      }
    ]
  }
]

Get enterprise-level statistics

Endpoint: GET /api/v3/enterprises/{enterpriseId}/statistics Retrieve overall statistics for the specified enterprise. The response includes information such as the number of users, disk space usage, number of SMS sent, and aggregated session data.

When to use:

• Displaying usage KPIs in an admin dashboard.

• Tracking resource consumption (disk usage, SMS, sessions) for billing or quota purposes.

• Monitoring the scale of an enterprise account over time.

Here are the statistic you will find in the response content:

Metrics	Description
user_count	Total number of active users in the enterprise.
disk_usage	Total disk space used by the enterprise, in megabytes (MB).
sms_count	Total number of SMS messages sent by the enterprise.
session_count	Total number of sessions created by the enterprise.
session_duration	Total duration of all sessions, in seconds.
session_billing_duration	Total billable duration of all sessions, in seconds.

Get enterprise statistics

get

https://cloud.apizee.comhttps://hds.apizee.com

/api/v3/enterprises/{enterpriseId}/statistics

Authorizations

access_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

enterpriseIdintegerRequired

Id of the enterprise

Query parameters

datestringOptional

Set a specific date, current date as default (format: 2020-01-01).

outputstring · enumOptional

Set the output format (default 'json').

Possible values:

Responses

200

Good case

No content

get

/api/v3/enterprises/{enterpriseId}/statistics

HTTPcURLJavaScriptPython

GET /api/v3/enterprises/{enterpriseId}/statistics HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Good case

No content