Pular navegação
Base de conhecimento

Analytics e cobrança

Relatórios analíticos e uso de recursos.

Billing

Consumo

GET {{baseHost}}/v1/billing/usage

Retorna as estatísticas de consumo no período indicado, agrupadas conforme solicitado. Útil para faturamento e planejamento de capacidade.

Nossa API devolve o consumo de recursos por projeto para dar mais granularidade; você pode somar o total do seu lado.

Se precisar, informe project_id como parâmetro GET para filtrar os resultados (editado)

Os tipos de produto são: - CDN (bytes) - Codificação (min) - Armazenamento (bytes)

Responses
{ "data": [  {   "date": "2024-01-01T00:00:00Z",   "usage": 85456358,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 65114706,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 29962188,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 904705,   "product": "cdn"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 0,   "product": "encoding"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 689510432,   "product": "live_traffic"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 69567273960,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 14996434987,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 34667181,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 130330116051,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 4172549388,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 16632753546,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 556115506,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 601660745,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 10406392731,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-01T00:00:00Z",   "usage": 6286301827,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 37429638,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 97450301,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 560037,   "product": "cdn"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 0,   "product": "encoding"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 882356207,   "product": "live_traffic"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 69567273960,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 14996434987,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 34667181,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 130330116051,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 4172549388,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 16632753546,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 556115506,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 601660745,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 10406392731,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-02T00:00:00Z",   "usage": 6286301827,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 12476546,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 36428908,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 618293,   "product": "cdn"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 0,   "product": "encoding"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 750185902,   "product": "live_traffic"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 69567273960,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 14996434987,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 34667181,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 130330116051,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 4172549388,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 16632753546,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 556115506,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 601660745,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 10406392731,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-03T00:00:00Z",   "usage": 6286301827,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 42455143,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 48519990,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 89726,   "product": "cdn"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 0,   "product": "encoding"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 877485751,   "product": "live_traffic"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 69567273960,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 14996434987,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 34667181,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 130330116051,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 4172549388,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 16632753546,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 556115506,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 601660745,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 10406392731,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-04T00:00:00Z",   "usage": 6286301827,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 114946977,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 45670557,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 79114792,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 1443490,   "product": "cdn"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 0,   "product": "encoding"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 802691136,   "product": "live_traffic"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 69567273960,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 14996434987,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 34667181,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 130330116051,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 4172549388,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 16632753546,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 556115506,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 601660745,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 10406392731,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-05T00:00:00Z",   "usage": 6286301827,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-06T00:00:00Z",   "usage": 7342272,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-06T00:00:00Z",   "usage": 24953092,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-06T00:00:00Z",   "usage": 38352386,   "product": "cdn",   "project_id": "<UUID>"  },  {   "date": "2024-01-06T00:00:00Z",   "usage": 511222,   "product": "cdn"  },  {   "date": "2024-01-06T00:00:00Z",   "usage": 0,   "product": "encoding"  },  {   "date": "2024-01-06T00:00:00Z",   "usage": 679400275,   "product": "live_traffic"  },  {   "date": "2024-01-06T00:00:00Z",   "usage": 69567273960,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-06T00:00:00Z",   "usage": 14996434987,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-06T00:00:00Z",   "usage": 34667181,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-06T00:00:00Z",   "usage": 130330116051,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-06T00:00:00Z",   "usage": 4172549388,   "product": "storage",   "project_id": "<UUID>"  },  {   "date": "2024-01-06T00:00:00Z",   "usage":// … truncated

Analytics

Visão geral

GET {{baseHost}}/v1/analytics/overview

Retorna estatísticas gerais de reprodução — visualizações, espectadores únicos, tempo assistido — no período indicado.

Responses
{  "meta": {    "time": {      "from": "2020-08-30T00:00:00Z",      "to": "2020-09-01T00:00:00Z",      "timezone": "Europe/Moscow"    }  },  "data": {    "total": {      "views": 0,      "duration": 0,      "watch_time": 0,      "player_loads": 0,      "date": "0001-01-01T00:00:00Z",      "unique_views": 0,      "online": 0    },    "timeline": [      {        "views": 0,        "duration": 0,        "watch_time": 0,        "player_loads": 0,        "date": "2020-08-29T21:00:00Z",        "unique_views": 0,        "online": 0      },      {        "views": 0,        "duration": 0,        "watch_time": 0,        "player_loads": 0,        "date": "2020-08-30T21:00:00Z",        "unique_views": 0,        "online": 0      }    ],    "top": {      "oses": null,      "devices": [        {          "name": "tv",          "views": 0,          "player_loads": 0,          "unique_views": 0        },        {          "name": "desktop",          "views": 0,          "player_loads": 0,          "unique_views": 0        },        {          "name": "tablet",          "views": 0,          "player_loads": 0,          "unique_views": 0        },        {          "name": "mobile",          "views": 0,          "player_loads": 0,          "unique_views": 0        }      ],      "browsers": null,      "countries": null,      "cities": null    }  }}

Personalizado

GET {{baseHost}}/v1/analytics

Retorna um recorte personalizado de analytics. Informe os campos a retornar, as dimensões de agrupamento e a ordenação.

Responses
{  "meta": {    "order": {      "view": "desc",      "play": "desc"    },    "time": {      "from": "2020-11-01T06:00:00Z",      "to": "2020-11-01T12:00:00Z",      "timezone": "Europe/Moscow"    },    "group_entities": [      "video_id"    ]  },  "data": []}