Through the API we expose the organisations analytics so that you are able to monitor and manage your video content. This is particularly relevant if you are integrating with another 3rd part like ChartBeat or have developed your own charting solution.
Querying
You are able to query for the analytics on the API by using the query `organisation` and retrieving the metrics from that object.
A sample query would be:
organisation(id: $id) {
metrics {
embedsCreatedCount
videoStreamsActiveCount
videoStreamsCount
videoStreamsGoalCountTodayPortion
videoStreams {
startTime
endTime
data {
timestamp
value
}
}
videoStreamsGoal {
startTime
endTime
data {
timestamp
value
}
}
}
}
where you are able to retrieve the organisation from either the Compass UI, or from querying the `currentUser` query.
Data Definitions
Name |
Description |
---|---|
embedsCreatedCount |
The number of embeds created in the last 24 hours |
videoStreamsActiveCount |
The number of currently viewing streams |
videoStreamsCount |
The number of streams completed today |
videoStreamsGoalCountTodayPortion |
The target number of streams for today |
Comments
0 comments
Please sign in to leave a comment.