VTurb Analytics API
馃嚙馃嚪 API do Analytics
馃嚙馃嚪 API do Analytics
  • Bem Vindo a API do Analytics do VTurb
  • Autentica莽茫o da API
  • Analytics
  • Release Notes
Powered by GitBook
On this page

Analytics

PreviousAutentica莽茫o da APINextRelease Notes

Namespace for all routes that are used broadly across vturb, this ultimately delivers the data to the front-end for our clients.

List all players

get

Returns a list of all players belonging to the authenticated user's company

Authorizations
Responses
200
Successful operation
application/json
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
get
GET /players/list HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "created_at": "2025-06-03T19:53:37.291Z"
  }
]
  • POSTReturns the active platforms for a company
  • POSTReturns the totals of conversions for each day in a company and player
  • POSTReturns the conversions grouped by timed for a company and player
  • POSTReturns the number of times the events happened as well as the count considering unique device and sessions
  • POSTReturns the totals of the events for each player in a company
  • POSTReturns the totals of the events for each day in a company
  • POSTReturns player leaderboards based on video engagement metrics
  • POSTReturns the total of users that reached a certain second of the video entire duration
  • POSTReturns an array with the engagement rate per day
  • POSTReturns an array with the engagement grouped by a field
  • POSTReturns an array with the engagement grouped by a field
  • POSTReturns the total of user clicks at a time in seconds related to the video
  • POSTReturns the totals of clicks for each day in a company and player
  • POSTStatistics used by the headlines dashboard
  • POSTReturns statistics grouped by a specified field
  • POSTReturns statistics grouped by a specified field broke by day
  • POSTReturns statistics grouped by a specified field
  • POSTReturns statistics grouped by a specified field and day
  • POSTCounts the utms of the given player
  • POSTStatistics used by the turbo dashboard
  • GETList all players

Returns the active platforms for a company

post

Returns a list with the company active platforms.

Authorizations
Body
start_datestring 路 dateRequired

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

timezonestringOptional

The timezone to use for the date filtering

Other propertiesanyOptional
Responses
200
Successful operation
application/json
Responsestring[]Example: ["kiwify","clickfunnels"]
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /conversions/active_platforms HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "start_date": "2023-10-26 18:24:05",
  "timezone": "America/Sao_Paulo"
}
[
  "kiwify",
  "clickfunnels"
]

Returns the totals of conversions for each day in a company and player

post

Returns a list with the company conversions grouped by day in a given period.

Authorizations
Body
player_idstringRequired

The ID of the player to search for

start_datestring 路 dateRequired

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

end_datestring 路 dateRequired

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

timezonestringOptional

The timezone to use for the date filtering

Other propertiesanyOptional
Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /conversions/stats_by_day HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "start_date": "2023-10-26 18:24:05",
  "end_date": "2023-11-26 18:24:05",
  "player_id": "64a5c8072e6fd10009828db2",
  "timezone": "America/Sao_Paulo"
}
{
  "events_by_day": [
    {
      "day": "2024-05-22",
      "total": 104,
      "total_uniq_device": 133,
      "total_uniq_session": 8
    }
  ],
  "total_events": 184,
  "total_uniq_device_events": 222,
  "total_uniq_session_events": 10
}

Returns the conversions grouped by timed for a company and player

post

Returns a list with the company conversions grouped by timed in a given period.

Authorizations
Body
player_idstringRequired

The ID of the player to search for

start_datestring 路 dateRequired

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

end_datestring 路 dateRequired

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

timezonestringOptional

The timezone to use for the date filtering

Other propertiesanyOptional
Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /conversions/video_timed HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "start_date": "2023-10-26 18:24:05",
  "end_date": "2023-11-26 18:24:05",
  "player_id": "64a5c8072e6fd10009828db2",
  "timezone": "America/Sao_Paulo"
}
{
  "company_id": "2b884cba-0b12-42ce-b3a1-7a3182d414df",
  "player_id": "64a5c8072e6fd10009828db2",
  "grouped_timed": [
    {
      "timed": 0,
      "timed_conversions": 100,
      "total_conversions": 200
    }
  ]
}

Returns the number of times the events happened as well as the count considering unique device and sessions

post

Returns a list with the companies and events with the number of times the event happened in a given period.

Authorizations
Body
eventsstring[]Required

Names of the events to filter by. Can be ['started', 'finished', 'viewed']

player_idstringOptional

The ID of the player to filter the results by.

start_datestring 路 dateOptional

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

end_datestring 路 dateOptional

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

Other propertiesanyOptional
Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /events/total_by_company HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "start_date": "2023-01-01",
  "end_date": "2024-01-31",
  "events": [
    "started",
    "viewed"
  ],
  "player_id": "65fb3c74ab21c70007b3e0dd"
}
[
  {
    "event": "text",
    "total": 1,
    "total_uniq_sessions": 1,
    "total_uniq_device": 1
  }
]

Returns the totals of the events for each player in a company

post

Returns a list with the companies grouped by its players and the number of times each event happened for each one in a given period.

Authorizations
Body
eventsstring[]Required

Names of the events to filter by. Can be ['started', 'finished', 'viewed']

start_datestring 路 dateOptional

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

end_datestring 路 dateOptional

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /events/total_by_company_players HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "start_date": "2023-01-01",
  "end_date": "2024-01-31",
  "events": [
    "started",
    "viewed"
  ],
  "players_start_date": [
    {
      "player_id": "65fb3c74ab21c70007b3e0dd",
      "start_date": "2023-01-01"
    }
  ]
}
[
  {
    "player_id": "text",
    "event": "text",
    "total": 1,
    "total_uniq_sessions": 1,
    "total_uniq_device": 1
  }
]

Returns the totals of the events for each day in a company

post

Returns a list with the companies grouped by day and the number of times each event happened for each day in a given period.

Authorizations
Body
player_idstringRequired

The ID of the player to search for

eventsstring[]Required

Names of the events to filter by. Can be ['started', 'finished', 'viewed']

start_datestring 路 dateOptional

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

end_datestring 路 dateOptional

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

timezonestringOptional

The timezone to use for the date filtering

Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /events/total_by_company_day HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "start_date": "2024-05-01",
  "end_date": "2024-05-15",
  "events": [
    "started",
    "viewed"
  ],
  "player_id": "64a5c8072e6fd10009828db2",
  "timezone": "America/Sao_Paulo"
}
{
  "company_id": "2b884cba-0b12-42ce-b3a1-7a3182d414df",
  "player_id": "64a5c8072e6fd10009828db2",
  "started": {
    "events_by_day": [
      {
        "day": "2024-05-22",
        "total": 104,
        "total_uniq_device": 133,
        "total_uniq_session": 8
      }
    ],
    "total_events": 184,
    "total_uniq_device_events": 222,
    "total_uniq_session_events": 10
  },
  "viewed": {
    "events_by_day": [
      {
        "day": "2024-05-22",
        "total": 104,
        "total_uniq_device": 133,
        "total_uniq_session": 8
      }
    ],
    "total_events": 184,
    "total_uniq_device_events": 222,
    "total_uniq_session_events": 10
  },
  "finished": {
    "events_by_day": [
      {
        "day": "2024-05-22",
        "total": 104,
        "total_uniq_device": 133,
        "total_uniq_session": 8
      }
    ],
    "total_events": 184,
    "total_uniq_device_events": 222,
    "total_uniq_session_events": 10
  }
}

Returns player leaderboards based on video engagement metrics

post

Provides leaderboard rankings of players based on their video engagement metrics (views, plays, pauses, etc...) within specified time periods. Multiple leaderboards with different player limits can be requested in a single call.

Authorizations
Body
company_idstringRequired

The ID of the company to search for

timezonestringOptional

The timezone to use for date calculations (defaults to 'Etc/UCT' if not provided)

Other propertiesanyOptional
Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized
post
POST /events/leaderboard HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 263

{
  "company_id": "2b884cba-0b12-42ce-b3a1-7a3182d414df",
  "leaderboards": [
    {
      "leaderboard_limit": 10,
      "start_date": "2023-10-26",
      "end_date": "2023-11-26",
      "event": "finished"
    },
    {
      "leaderboard_limit": 5,
      "start_date": "2023-09-26",
      "event": "started"
    }
  ],
  "timezone": "America/Sao_Paulo"
}
[
  {
    "leaderboard_name": "text",
    "event": "text",
    "leaderboards": [
      {
        "player_id": "text",
        "total_plays": 1,
        "uniq_plays": 1,
        "uniq_device_plays": 1
      }
    ]
  }
]

Returns the total of users that reached a certain second of the video entire duration

post

Returns an object containing the overall engagement of the users in a given period for the specified player.

Authorizations
Body
player_idstringRequired

The ID of the player to search for

video_durationintegerRequired

The total duration of the video in seconds

start_datestring 路 dateOptional

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC"

end_datestring 路 dateOptional

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC"

timezonestringOptional

The timezone to use for the date filtering

Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /times/user_engagement HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 161

{
  "start_date": "2023-10-26 18:24:05",
  "end_date": "2023-11-26 18:24:05",
  "player_id": "65fb3c74ab21c70007b3e0dd",
  "video_duration": 3600,
  "timezone": "America/Sao_Paulo"
}
{
  "average_watched_time": 184,
  "engagement_rate": 10,
  "grouped_timed": [
    {
      "timed": 0,
      "total_users": 200
    }
  ]
}

Returns an array with the engagement rate per day

post

Returns an array containing the overall engagement of the users in a given period for the specified player per day.

Authorizations
Body
player_idstringRequired

The ID of the player to search for

video_durationintegerRequired

The total duration of the video in seconds

start_datestring 路 dateRequired

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC"

end_datestring 路 dateRequired

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC"

timezonestringOptional

The timezone to use for the date filtering

Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /times/user_engagement_by_day HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "start_date": "2023-10-26 18:24:05",
  "end_date": "2023-11-26 18:24:05",
  "player_id": "65fb3c74ab21c70007b3e0dd",
  "video_duration": "3600,",
  "timezone": "America/Sao_Paulo"
}
[
  {
    "date": "2024-01-01",
    "engagement_rate": 23
  }
]

Returns an array with the engagement grouped by a field

post

Returns an array containing the overall engagement of the users in a given period for the specified player per day.

Authorizations
Body
player_idstringRequired

The ID of the player to search for

fieldstringRequired

The field to group the engagement by, possible values are 'country', 'browser', 'device_type', 'utm_campain', 'utm_source', 'utm_medium', 'utm_content', 'utm_term' If 'no_attribution' is passed, all values that have been set to null or that are empty strings will be returned.

valuesstring[]Required

The values to filter the field by, for example ['Brazil', 'Romenia'] or ['Chrome', 'Firefox']

start_datestring 路 dateRequired

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC"

end_datestring 路 dateRequired

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC"

timezonestringOptional

The timezone to use for the date filtering

Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /times/user_engagement_by_field HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "start_date": "2023-10-26 18:24:05",
  "end_date": "2023-11-26 18:24:05",
  "player_id": "65fb3c74ab21c70007b3e0dd",
  "field": "country",
  "values": [
    "Brazil"
  ],
  "timezone": "America/Sao_Paulo"
}
[
  {
    "group_key": "Brazil",
    "group_values": [
      {
        "timed": 0,
        "total_users": 200
      }
    ]
  }
]

Returns an array with the engagement grouped by a field

post

Returns an array containing the overall engagement of the users in a given period for the specified player per day.

Authorizations
Body
player_idstringRequired

The ID of the player to search for

query_keystringRequired

The query param key to group the engagement by, possible values example: 'utm_campain', 'utm_source', 'utm_medium', 'utm_content', 'utm_term'

valuesstring[]Required

The values to filter the query key parameter by, for example ['Facebook', 'Google', 'Campaign 1', 'Campaign 2']

start_datestring 路 dateRequired

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

end_datestring 路 dateRequired

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

timezonestringOptional

The timezone to use for the date filtering

Other propertiesanyOptional
Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /times/user_engagement_by_traffic_origin HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "start_date": "2023-10-26 18:24:05",
  "end_date": "2023-11-26 18:24:05",
  "player_id": "65fb3c74ab21c70007b3e0dd",
  "query_key": "utm_source",
  "values": [
    "utm_source_1",
    "utm_source_2"
  ],
  "timezone": "America/Sao_Paulo"
}
{
  "data": [
    {
      "group_key": "Brazil",
      "group_values": [
        {
          "timed": 0,
          "total_users": 200
        }
      ]
    }
  ]
}

Returns the total of user clicks at a time in seconds related to the video

post

Returns an object containing the all the clicks grouped by the time in seconds it happened related to the video.

Authorizations
Body
player_idstringRequired

The ID of the player to search for

start_datestring 路 dateRequired

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC"

end_datestring 路 dateRequired

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC"

timezonestringOptional

The timezone to use for the date filtering

Other propertiesanyOptional
Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /clicks/total_by_company_timed HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 161

{
  "start_date": "2023-10-26 18:24:05",
  "end_date": "2023-11-26 18:24:05",
  "player_id": "65fb3c74ab21c70007b3e0dd",
  "video_duration": 3600,
  "timezone": "America/Sao_Paulo"
}
[
  {
    "timed": 0,
    "total_users": 200
  }
]

Returns the totals of clicks for each day in a company and player

post

Returns a list with the company clicks grouped by day in a given period.

Authorizations
Body
player_idstringRequired

The ID of the player to search for

start_datestring 路 dateRequired

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

end_datestring 路 dateRequired

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

timezonestringOptional

The timezone to use for the date filtering

Other propertiesanyOptional
Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /clicks/total_by_company_day HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "start_date": "2024-05-01",
  "end_date": "2024-05-15",
  "player_id": "64a5c8072e6fd10009828db2",
  "timezone": "America/Sao_Paulo"
}
{
  "events_by_day": [
    {
      "day": "2024-05-22",
      "total": 104,
      "total_uniq_device": 133,
      "total_uniq_session": 8
    }
  ],
  "total_events": 184,
  "total_uniq_device_events": 222,
  "total_uniq_session_events": 10
}

Statistics used by the headlines dashboard

post

Returns several statistics used by the headlines dashboard. Engagement, views and play rate are among these metrics

Authorizations
Body
start_datestring 路 dateRequired

Start date of the period for event querying.

player_idstringRequired

The player being analysed.

video_durationintegerRequired

The duration of the video

pitch_timeintegerRequired

The time in seconds that the video must be watched to be considered a pitch

Responses
200
Successful operation
application/json
400
If a 400 error occurs, it means parameters were incorrectly passed, and the response body will contain an explanation.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /headlines/stats_by_player HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "start_date": "2023-01-01 00:00:00",
  "player_id": "64a5c8072e6fd10009828db2",
  "video_duration": 1000
}
[
  {
    "engagement": 15.5,
    "number": 5,
    "play_over_engagement": 0.65,
    "play_rate": 0.35,
    "views": 140,
    "pitch": 10,
    "clicks": 10,
    "plays": 10,
    "conversions": 10,
    "amount_brl": 10,
    "amount_usd": 10,
    "amount_eur": 10,
    "conversion_rate": 10
  },
  {
    "engagement": 15.5,
    "number": 4,
    "play_over_engagement": 0.65,
    "play_rate": 0.55,
    "views": 150,
    "pitch": 10,
    "clicks": 10,
    "plays": 10,
    "conversions": 10,
    "amount_brl": 10,
    "amount_usd": 10,
    "amount_eur": 10,
    "conversion_rate": 10
  },
  {
    "engagement": 15.5,
    "number": 3,
    "play_over_engagement": 0.65,
    "play_rate": 0.55,
    "views": 200,
    "pitch": 10,
    "clicks": 10,
    "plays": 10,
    "conversions": 10,
    "amount_brl": 10,
    "amount_usd": 10,
    "amount_eur": 10,
    "conversion_rate": 10
  }
]

Returns statistics grouped by a specified field

post

Returns statistics for sessions grouped by a specified field for a given company and player within a date range.

Authorizations
Body
player_idstringRequired

The ID of the player to search for

start_datestring 路 dateRequired

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

end_datestring 路 dateRequired

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

fieldstringRequired

The field to group the statistics by

video_durationintegerRequired

The total duration of the video in seconds

timezonestringOptional

The timezone to use for the date filtering

pitch_timeintegerOptional

The time in seconds that the video must be watched to be considered a pitch

Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /sessions/stats_by_field HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "start_date": "2023-01-01",
  "end_date": "2024-01-31",
  "player_id": "65fb3c74ab21c70007b3e0dd",
  "field": "browser",
  "video_duration": 3600,
  "timezone": "America/Sao_Paulo",
  "pitch_time": 10
}
{
  "company_id": "2b884cba-0b12-42ce-b3a1-7a3182d414df",
  "player_id": "65fb3c74ab21c70007b3e0dd",
  "field": "browser",
  "video_duration": 3600,
  "timezone": "America/Sao_Paulo",
  "pitch_time": 10,
  "total_viewed": 200,
  "total_viewed_device_uniq": 180,
  "total_started": 250,
  "total_started_session_uniq": 230,
  "total_started_device_uniq": 220,
  "total_finished": 150,
  "total_finished_session_uniq": 140,
  "total_finished_device_uniq": 130,
  "engagement_rate": 75.56,
  "total_clicked": 50,
  "total_clicked_device_uniq": 45,
  "total_clicked_session_uniq": 40,
  "total_viewed_session_uniq": 190,
  "grouped_field": "Chrome",
  "total_over_pitch": 30,
  "total_under_pitch": 10,
  "over_pitch_rate": 75,
  "total_conversions": 10,
  "overall_conversion_rate": 2.56,
  "total_amount_usd": 1000,
  "total_amount_brl": 1000,
  "total_amount_eur": 1000,
  "play_rate": 2.56
}

Returns statistics grouped by a specified field broke by day

post

Returns statistics for sessions grouped by a specified field for a given company and player within a date range and broke by day.

Authorizations
Body
player_idstringRequired

The ID of the player to search for

start_datestring 路 dateRequired

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

end_datestring 路 dateRequired

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

fieldstringRequired

The field to group the statistics by

video_durationintegerRequired

The total duration of the video in seconds

timezonestringOptional

The timezone to use for the date filtering

pitch_timeintegerOptional

The time in seconds that the video must be watched to be considered a pitch

Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /sessions/stats_by_field_by_day HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "start_date": "2023-01-01",
  "end_date": "2024-01-31",
  "player_id": "65fb3c74ab21c70007b3e0dd",
  "field": "browser",
  "video_duration": 3600,
  "timezone": "America/Sao_Paulo",
  "pitch_time": 10
}
[
  {
    "date_key": "2024-01-01",
    "field": "browser",
    "video_duration": 3600,
    "timezone": "America/Sao_Paulo",
    "pitch_time": 10,
    "total_viewed": 200,
    "total_viewed_device_uniq": 180,
    "total_started": 250,
    "total_started_session_uniq": 230,
    "total_started_device_uniq": 220,
    "total_finished": 150,
    "total_finished_session_uniq": 140,
    "total_finished_device_uniq": 130,
    "engagement_rate": 75.56,
    "total_clicked": 50,
    "total_clicked_device_uniq": 45,
    "total_clicked_session_uniq": 40,
    "total_viewed_session_uniq": 190,
    "grouped_field": "Chrome",
    "total_over_pitch": 30,
    "total_under_pitch": 10,
    "over_pitch_rate": 75,
    "total_conversions": 10,
    "overall_conversion_rate": 2.56,
    "total_amount_usd": 1000,
    "total_amount_brl": 1000,
    "total_amount_eur": 1000,
    "play_rate": 2.56
  }
]

Returns statistics grouped by a specified field

post

Returns statistics for traffic origin grouped by a specified query key for a given company and player within a date range.

Authorizations
Body
player_idstringRequired

The ID of the player to search for

start_datestring 路 dateRequired

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

end_datestring 路 dateRequired

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

query_keystringRequired

The query key to group the statistics by

video_durationintegerRequired

The total duration of the video in seconds

timezonestringOptional

The timezone to use for the date filtering

pitch_timeintegerOptional

The time in seconds that the video must be watched to be considered a pitch

Other propertiesanyOptional
Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /traffic_origin/stats HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "start_date": "2023-01-01",
  "end_date": "2024-01-31",
  "player_id": "65fb3c74ab21c70007b3e0dd",
  "query_key": "utm_campaign",
  "video_duration": 3600,
  "timezone": "America/Sao_Paulo",
  "pitch_time": 10
}
{
  "company_id": "2b884cba-0b12-42ce-b3a1-7a3182d414df",
  "player_id": "65fb3c74ab21c70007b3e0dd",
  "field": "browser",
  "video_duration": 3600,
  "timezone": "America/Sao_Paulo",
  "pitch_time": 10,
  "total_viewed": 200,
  "total_viewed_device_uniq": 180,
  "total_started": 250,
  "total_started_session_uniq": 230,
  "total_started_device_uniq": 220,
  "total_finished": 150,
  "total_finished_session_uniq": 140,
  "total_finished_device_uniq": 130,
  "engagement_rate": 75.56,
  "total_clicked": 50,
  "total_clicked_device_uniq": 45,
  "total_clicked_session_uniq": 40,
  "total_viewed_session_uniq": 190,
  "grouped_field": "Chrome",
  "total_over_pitch": 30,
  "total_under_pitch": 10,
  "over_pitch_rate": 75,
  "total_conversions": 10,
  "overall_conversion_rate": 2.56,
  "total_amount_usd": 1000,
  "total_amount_brl": 1000,
  "total_amount_eur": 1000,
  "play_rate": 2.56
}

Returns statistics grouped by a specified field and day

post

Returns statistics for traffic origin grouped by a specified query key for a given company and player within a date range and grouped by day.

Authorizations
Body
player_idstringRequired

The ID of the player to search for

start_datestring 路 dateRequired

Start date of the period for event querying. This will be used as >=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

end_datestring 路 dateRequired

End date of the period for event querying. This will be used as <=. Format examples "2023-10-26T18:24:05.000+00:00" or "2023-10-26 18:24:05 UTC" or "2023-10-26"

query_keysstring[]Optional

The query keys to group the statistics by

video_durationintegerRequired

The total duration of the video in seconds

timezonestringOptional

The timezone to use for the date filtering

pitch_timeintegerOptional

The time in seconds that the video must be watched to be considered a pitch

Other propertiesanyOptional
Responses
200
Successful operation
application/json
400
Bad request: the request was bad formatted and some of the arguments were missing or wrong, look at the response body for more information.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /traffic_origin/stats_by_day HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "start_date": "2023-01-01",
  "end_date": "2024-01-31",
  "player_id": "65fb3c74ab21c70007b3e0dd",
  "query_keys": [
    "utm_campaign"
  ],
  "video_duration": 3600,
  "timezone": "America/Sao_Paulo",
  "pitch_time": 10
}
[
  {
    "date_key": "2025-06-03",
    "query_key": "text",
    "grouped_field": "text",
    "total_viewed": 1,
    "total_viewed_session_uniq": 1,
    "total_viewed_device_uniq": 1,
    "total_started": 1,
    "total_started_session_uniq": 1,
    "total_started_device_uniq": 1,
    "total_finished": 1,
    "total_finished_session_uniq": 1,
    "total_finished_device_uniq": 1,
    "total_clicked": 1,
    "total_clicked_session_uniq": 1,
    "total_clicked_device_uniq": 1,
    "engagement_rate": 1,
    "total_over_pitch": 1,
    "total_under_pitch": 1,
    "over_pitch_rate": 1,
    "total_conversions": 1,
    "overall_conversion_rate": 1,
    "total_amount_usd": 1,
    "total_amount_brl": 1,
    "total_amount_eur": 1,
    "play_rate": 1
  }
]

Counts the utms of the given player

post

Counts the utms of the given player. The values are src, sck, utm_source, utm_medium, utm_campaign, utm_term, utm_content, among any other valid query parameter

Authorizations
Body
start_datestring 路 dateRequired

Start date of the period for event querying.

end_datestring 路 dateOptional

Start date of the period for event querying.

player_idstringRequired

The player being analysed.

Responses
200
Successful operation
application/json
400
If a 400 error occurs, it means parameters were incorrectly passed, and the response body will contain an explanation.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /traffic_origin/valid_utms HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "player_id": "64a5c8072e6fd10009828db2",
  "start_date": "2024-01-01 00:00:00",
  "end_date": "2024-05-01 00:00:00"
}
[
  {
    "sck": 10,
    "src": 11,
    "utm_source": 15,
    "utm_campaign": 7,
    "utm_content": 2,
    "utm_term": 3,
    "utm_medium": 4
  }
]

Statistics used by the turbo dashboard

post

Returns several statistics used by the turbo dashboard. Speed, engagement, views, pitch and clicks are among these metrics

Authorizations
Body
start_datestring 路 dateRequired

Start date of the period for event querying.

player_idstringRequired

The player being analysed.

video_durationintegerRequired

The duration of the video

pitch_timeintegerRequired

The time in seconds that the video must be watched to be considered a pitch

Responses
200
Successful operation
application/json
400
If a 400 error occurs, it means parameters were incorrectly passed, and the response body will contain an explanation.
401
Unauthorized, missing proper X-Api-Token or X-Api-Version
post
POST /turbo/stats_by_player HTTP/1.1
Host: analytics.vturb.net
X-Api-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "start_date": "2023-01-01 00:00:00",
  "player_id": "64a5c8072e6fd10009828db2",
  "video_duration": 1000,
  "pitch_time": 10
}
[
  {
    "engagement": 15.5,
    "number": 5,
    "play_over_engagement": 0.65,
    "play_rate": 0.35,
    "views": 140
  },
  {
    "engagement": 15.5,
    "number": 4,
    "play_over_engagement": 0.65,
    "play_rate": 0.55,
    "views": 150
  },
  {
    "engagement": 15.5,
    "number": 3,
    "play_over_engagement": 0.65,
    "play_rate": 0.55,
    "views": 200
  }
]