Get unique viewers via CDN

Counts the number of unique viewers of a video entity over CDN. It doesn’t matter what player you used.

All unique viewers for the specified period of time are counted.

How does it work?

Calculating the number of unique viewers for a Live stream or VOD over CDN involves aggregating and analyzing various metrics to ensure each individual viewer is counted only once, regardless of how many times they connect or disconnect during the stream.

This method provides statistics for any video viewing by unique users, regardless of viewing method and a player you used. Thus, this is the most important difference from viewing through the built-in player:

• In method /statistics/uniqs viewers of the built-in player are tracked only.
• But this method tracks all viewers from everywhere.

This method is a combination of two other Live and VOD detailed methods. If you need detailed information, then see the methods: /statistics/stream/viewers and /statistics/vod/viewers.

Data Processing and Deduplication

We us IP Address & User-Agent combination. Each unique combination of IP address and User-Agent string might be considered a unique viewer.

This approach allows to accurately estimate the number of unique viewers. However, this is not foolproof due to NAT (Network Address Translation) and shared networks. Thus if your users fall under such restrictions, then the number of unique viewers may be higher than calculated.

Why is there no “Unique Views” method?

Based on CDN data, we can calculate the number of unique viewers only. Thus only your player will be able to count the number of unique views (clicks on the Play button) within the player session (i.e. how many times 1 unique viewer clicked the Play button within a unique player’s session).

GET /streaming/statistics/cdn/uniqs

Get unique viewers via CDN

cURL

curl --request GET \
  --url https://api.gcore.com/streaming/statistics/cdn/uniqs \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.gcore.com/streaming/statistics/cdn/uniqs"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/streaming/statistics/cdn/uniqs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/streaming/statistics/cdn/uniqs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/streaming/statistics/cdn/uniqs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/streaming/statistics/cdn/uniqs")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/streaming/statistics/cdn/uniqs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "uniqs": 100,
      "type": "vod"
    },
    {
      "uniqs": 300,
      "type": "live"
    }
  ]
}

{
  "data": [],
  "errors": [
    "from: query param is not set"
  ]
}

{
  "data": [],
  "errors": [
    "internal server error"
  ]
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

date_from · string · required

Start of time frame. Format is date time in ISO 8601.

date_to · string · required

End of time frame. Format is date time in ISO 8601.

type · enum<string>

Filter by entity's type

Available options: live, vod, playlist

id · string

Filter by entity's id. Put ID of a Live stream, VOD or a playlist to be calculated.

If the value is omitted, then the calculation is done for all videos/streams of the specified type.

When using this "id" parameter, be sure to specify the "type" parameter too. If you do not specify a type, the "id" will be ignored.

Response

200

application/json

OK

data · object[]

Show child attributes