Skip to main content
GET
/
analytics
Fetch analytics
curl --request GET \
  --url https://api.vidbeo.com/v2/analytics \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "result": [
    {
      "day": "2023-12-21",
      "views": 10
    }
  ],
  "links": {},
  "errors": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
dimension
enum<string>
required

The bucket each value falls into (the x-axis)

Available options:
day,
country,
domain
Example:

"day"

​
metric
enum<string>
required

The value within each metric (the y-axis))

Available options:
views
Example:

"views"

​
start
string<date>
required

The start date

Example:

"2023-12-20T00:00:00.000Z"

​
end
string<date>
required

The end date

Example:

"2023-12-21T00:00:00.000Z"

​
filter
string

Only include events that match a particular restriction. For example to only include the views for a particular video ID. This should be 'name:operator:value'. You need to URL-encode the value if it contains non-alphanumeric characters

Example:

"video_id:eq:abcde12345abcde12345a"

​
by
enum<string>

Order by the x-axis (the chosen dimension) or y-axis (the chosen metric). For example to see the days that had the most views, you would use 'views'. If you were plotting the results on a graph, you might like to use 'date'

Available options:
views
Example:

"views"

​
limit
integer

The number of rows returned. Useful to show the top X, such as the top 10

Required range: 1 <= x <= 100
Example:

10

Response

Analytics

​
success
boolean
required
Example:

true

​
result
object[]
required
​
links
object
required
Example:
{}
​
errors
object[]
required
Example:
[]