Retenção, impressões e CTR
GET /v1/insights/retention escopo read
Retenção (% assistida e tempo médio), impressões e CTR do YouTube e taxa de pulo do Instagram, por post. Dado que a rede não entrega vem null, com o motivo em retention.message. Exige a permissão yt-analytics.readonly, que a conexão do YouTube já pede (canais conectados antes dela precisam reautorizar uma vez).
Cabeçalhos
Authorization: Bearer praeko_… e X-Praeko-Contract: en. Sempre envie os dois.Exemplo
curl "https://praeko.app/v1/insights/retention" \
-H "Authorization: Bearer $PRAEKO_KEY" \
-H "X-Praeko-Contract: en"const res = await fetch("https://praeko.app/v1/insights/retention", {
method: "GET",
headers: {
"Authorization": `Bearer ${process.env.PRAEKO_KEY}`,
"X-Praeko-Contract": "en",
},
});
console.log(res.status, await res.json());// O @praeko/sdk ainda não tem um método para esta rota: use o fetch (aba JavaScript).
const res = await fetch("https://praeko.app/v1/insights/retention", {
method: "GET",
headers: {
"Authorization": `Bearer ${process.env.PRAEKO_KEY}`,
"X-Praeko-Contract": "en",
},
});
console.log(res.status, await res.json());import os
import requests
resp = requests.get(
"https://praeko.app/v1/insights/retention",
headers={
"Authorization": f"Bearer {os.environ['PRAEKO_KEY']}",
"X-Praeko-Contract": "en",
},
)
print(resp.status_code, resp.json())<?php
$ch = curl_init('https://praeko.app/v1/insights/retention');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("PRAEKO_KEY"),
'X-Praeko-Contract: en',
],
]);
$resposta = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $resposta, PHP_EOL;
curl_close($ch);package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest("GET", "https://praeko.app/v1/insights/retention", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("PRAEKO_KEY"))
req.Header.Set("X-Praeko-Contract", "en")
resp, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
out, _ := io.ReadAll(resp.Body)
fmt.Println(resp.Status, string(out))
}require "net/http"
require "uri"
uri = URI("https://praeko.app/v1/insights/retention")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV['PRAEKO_KEY']}"
request["X-Praeko-Contract"] = "en"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.code, response.bodyusing System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://praeko.app/v1/insights/retention");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("PRAEKO_KEY"));
request.Headers.Add("X-Praeko-Contract", "en");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://praeko.app/v1/insights/retention"))
.header("Authorization", "Bearer " + System.getenv("PRAEKO_KEY"))
.header("X-Praeko-Contract", "en")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}http GET "https://praeko.app/v1/insights/retention" \
"Authorization: Bearer $PRAEKO_KEY" \
"X-Praeko-Contract: en"Esta rota ainda não tem chamada própria no SDKO exemplo usa
fetch.Sem SDK oficialExemplo com a biblioteca padrão (ou o cliente HTTP) da linguagem. Só o SDK de JavaScript existe.
Sem SDK oficialExemplo com a biblioteca padrão (ou o cliente HTTP) da linguagem. Só o SDK de JavaScript existe.
Sem SDK oficialExemplo com a biblioteca padrão (ou o cliente HTTP) da linguagem. Só o SDK de JavaScript existe.
Sem SDK oficialExemplo com a biblioteca padrão (ou o cliente HTTP) da linguagem. Só o SDK de JavaScript existe.
Sem SDK oficialExemplo com a biblioteca padrão (ou o cliente HTTP) da linguagem. Só o SDK de JavaScript existe.
Sem SDK oficialExemplo com a biblioteca padrão (ou o cliente HTTP) da linguagem. Só o SDK de JavaScript existe.
Resposta
| Status de sucesso | Quando |
|---|---|
200 |
Sucesso. |
{
"period": {
"from": "2026-10-08T14:02:11.482Z",
"to": "2026-11-07T14:02:11.482Z"
},
"channels": [
{
"channelId": "01KA3V0R5D8M2WQ7X4HT9NZ1BF",
"network": "youtube",
"name": "Canal do Marcone",
"state": "ready",
"message": "Retenção por vídeo, impressões e CTR, pela API do YouTube Analytics."
}
],
"total": 1,
"items": [
{
"id": "youtube:dQw4w9WgXcQ",
"network": "youtube",
"channelId": "01KA3V0R5D8M2WQ7X4HT9NZ1BF",
"title": "O teste que só falhava na segunda",
"type": "short",
"publishedAt": "2026-11-01T12:00:00Z",
"url": "https://youtu.be/dQw4w9WgXcQ",
"origin": "imported",
"views": 1240,
"reach": null,
"impressions": 9800,
"ctr": 5.5,
"avgViewPercentage": 47.5,
"avgWatchTimeSec": 31.2,
"watchTimeMin": 2500.5,
"retention": {
"state": "ready",
"source": "youtube-analytics",
"collectedAt": "2026-11-07T15:40:03.120Z",
"points": 100
}
}
],
"collection": {
"last": "2026-11-07T14:02:11.482Z"
}
}Número que a rede ainda não entregou vem null, nunca 0. retention.state: ready, pending, reauthorize, unavailable ou error.
Erros
Sem erros específicos desta rota além dos comuns.
Erros de qualquer rota
| Status | code | Quando |
|---|---|---|
| 401 | unauthorized |
Faltou o cabeçalho Authorization: Bearer …. |
| 401 | invalid_api_key |
A chave não existe. |
| 401 | revoked_api_key |
A chave foi revogada. |
| 401 | expired_api_key |
A chave expirou. |
| 403 | forbidden |
O escopo da chave não basta para esta rota (veja o selo de escopo). |
| 429 | rate_limited |
Passou do limite de requisições por minuto. |
O corpo de todo erro é { "error": { "code", "message", "details"? } }. Veja todos os códigos.
Testar
Testar
Entre para testarO teste ao vivo usa a sua chave e a sua conta. Para quem não entrou, fica desligado.
Dúvida ou erro nesta página? contato@praeko.appVer .md