Usage reports

The Reports API can provide insightful data about your Video API usage. Use this data to simplify customer billing, compare usage patterns, and enhance your business intelligence, turning raw metrics into actionable growth strategies.

Generate a Report

The Reports API provides detailed documentation to guide you through generating reports for your Video API project, or any other Vonage project. It includes step-by-step instructions, code snippets, and tutorials to help you retrieve and analyze your data.

To retrieve information about your project’s Video API usage, include VIDEO-API as the product parameter when generating the report.git

How to Interpret your Data

Types of Events

Here’s a list of the most common events and their meaning:

  • Broadcasting: Indicates the start of a broadcast. Broadcasts can be used to stream content to multiple participants in real time.
  • Subscriber minutes: Tracks the total minutes a subscriber spends connected to a session. Useful for usage metrics and billing calculations.
  • Video Session: Represents the start of a Video API session where participants meet, interact, and share audio/video. This event can be triggered multiple times for the same session if multiple meeting_id are generated.
  • Archiving: Indicates that a session’s audio, video, or data has been recorded and stored for later retrieval.
  • HLS: Indicates the start of a HSL broadcast.
  • Experience composer: Indicates that the Experience Composer has been added to the stream.

Event properties

account_id: The unique identifier of your account.

feature_name: The name of the event being tracked. Some events are purely informational, while others include additional data that provides more context about the event.

session_id: The unique identifier of a Video API session in which participants meet and chat. Sessions can be thought of as virtual rooms. Found in the Video Session events.

meeting_id: The unique identifier of a meeting automatically created within a session when participants join. If a session becomes empty and participants later join, a new meeting ID is generated. This identifier is used solely to track session usage in reports.

subscriber_id: The unique identifier of a user subscribed to a session. Found in the Subscriber Minutes events.

archive_id: The unique identifier of a file archived from a session.

broadcast_id: The unique identifier of a broadcast. It can be used to retrieve detailed information about that broadcast.

hls_id: The identifier of the HLS Broadcast event. It matches the broadcast identifier.

composer_id: The unique ID for the Experience Composer used in the session.

application_id: The unique identifier of the application that triggered the event.

duration: For time-relevant events, the length of time the event lasted.

date_start: The date and time when the event was triggered.

date_end: For events with a duration, the date and time when the event ended. For events without a duration, this will match date_start.

total_price: The total cost associated with the event. For events without a cost, this field is 0. The currency for this amount is specified in the currency property.

currency: The currency in which the event’s total_price is expressed.

id: Event unique identifier.