# Metrics

> Metrics: GET /v1/insights. Cards, top posts, results per channel (one row per account when a network has several; channel filters one), summary and the 48 h reading.

Source: https://praeko.app/docs/en/api/insights/metrics

`GET /v1/insights` · minimum scope: read

Cards, top posts, results per channel (one row per account when a network has several; `channel` filters one), summary and the 48 h reading.

> **Headers** `Authorization: Bearer praeko_…` and `X-Praeko-Contract: en`. Always send both.

## Parameters

| Name | In | Description |
|---|---|---|
| `channel` | query | Account id when the network has several (from `GET /v1/channels`). Without it, the default channel. |

## Example

**curl**

```bash
curl "https://praeko.app/v1/insights" \
  -H "Authorization: Bearer $PRAEKO_KEY" \
  -H "X-Praeko-Contract: en"
```

**JavaScript**

```js
const res = await fetch("https://praeko.app/v1/insights", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.PRAEKO_KEY}`,
    "X-Praeko-Contract": "en",
  },
});
console.log(res.status, await res.json());
```

**Node**

```js
import { Praeko } from "@praeko/sdk";

const praeko = new Praeko({ url: "https://praeko.app", key: process.env.PRAEKO_KEY });
const resultado = await praeko.insights.get();
console.log(resultado);
```

**Python**

```python
import os
import requests

resp = requests.get(
    "https://praeko.app/v1/insights",
    headers={
        "Authorization": f"Bearer {os.environ['PRAEKO_KEY']}",
        "X-Praeko-Contract": "en",
    },
)
print(resp.status_code, resp.json())
```

**PHP**

```php
<?php
$ch = curl_init('https://praeko.app/v1/insights');
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);
```

**Go**

```go
package main

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

func main() {
	req, err := http.NewRequest("GET", "https://praeko.app/v1/insights", 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))
}
```

**Ruby**

```ruby
require "net/http"
require "uri"

uri = URI("https://praeko.app/v1/insights")
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.body
```

**C#**

```csharp
using 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");
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()}");
```

**Java**

```java
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"))
            .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());
    }
}
```

**HTTPie**

```bash
http GET "https://praeko.app/v1/insights" \
  "Authorization: Bearer $PRAEKO_KEY" \
  "X-Praeko-Contract: en"
```

> Official SDK for Node: Install it with `npm install @praeko/sdk` (see [SDK and CLI](https://praeko.app/docs/en/sdk)).

## Response

| Success status | When |
|---|---|
| `200` | Success. |

**Response 200**

```json
{
  "period": {
    "from": "2026-10-08T14:02:11.482Z",
    "to": "2026-11-07T14:02:11.482Z"
  },
  "previousPeriod": {
    "from": "2026-09-08T14:02:11.482Z",
    "to": "2026-10-08T14:02:11.482Z"
  },
  "filters": {
    "channel": null,
    "type": null,
    "tag": null
  },
  "cards": {
    "posts": 6,
    "followers": 1842,
    "followersChange": 37,
    "reactions": 412,
    "comments": 58,
    "engagement": 9,
    "overallEngagement": 9,
    "views": 5120,
    "shares": null,
    "saves": null,
    "reach": null,
    "watchTimeMin": null,
    "avgWatchTimeSec": null,
    "followersGained": null,
    "previous": {
      "posts": 4,
      "followers": 1805,
      "followersChange": null,
      "reactions": 301,
      "comments": 40,
      "engagement": 8,
      "overallEngagement": 8,
      "views": 3900,
      "shares": null,
      "saves": null,
      "reach": null,
      "watchTimeMin": null,
      "avgWatchTimeSec": null,
      "followersGained": null
    },
    "change": {
      "posts": {
        "absolute": 2,
        "pct": 50
      },
      "followers": {
        "absolute": 37,
        "pct": 2
      },
      "reactions": {
        "absolute": 111,
        "pct": 37
      },
      "comments": {
        "absolute": 18,
        "pct": 45
      },
      "engagement": null,
      "views": {
        "absolute": 1220,
        "pct": 31
      },
      "shares": null,
      "saves": null,
      "reach": null,
      "watchTimeMin": null,
      "avgWatchTimeSec": null,
      "followersGained": null
    }
  },
  "sources": {
    "current": {},
    "previous": {},
    "bufferAggregate": false,
    "aggregateUpdatedAt": null,
    "scope": "all"
  },
  "topPosts": [
    {
      "title": "The test that only failed on Mondays",
      "network": "youtube",
      "type": "short",
      "publishedAt": "2026-11-01T12:00:00.000Z",
      "reactions": 87,
      "comments": 12,
      "views": 1240,
      "engagement": 8,
      "url": "https://youtu.be/dQw4w9WgXcQ",
      "thumb": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hqdefault.jpg",
      "thumbType": "url",
      "noMetrics": false
    }
  ],
  "channels": [
    {
      "network": "youtube",
      "name": "Marcone's Channel",
      "avatar": "/v1/channels/youtube/avatar",
      "posts": 6,
      "reactions": 412,
      "comments": 58,
      "views": 5120,
      "engagement": 9,
      "shares": null,
      "saves": null,
      "reach": null,
      "watchTimeMin": null,
      "avgWatchTimeSec": null
    }
  ],
  "summary": [
    {
      "title": "Technical Shorts are in the lead",
      "text": "Behind-the-code posts got twice as many views as the others."
    }
  ],
  "posts": {
    "total": 1,
    "page": 1,
    "limit": 50,
    "sort": "reactions",
    "direction": "desc",
    "items": [
      {
        "id": "youtube:dQw4w9WgXcQ",
        "network": "youtube",
        "channelId": "01KA3V0R5D8M2WQ7X4HT9NZ1BF",
        "title": "The test that only failed on Mondays",
        "type": "short",
        "publishedAt": "2026-11-01T12:00:00Z",
        "url": "https://youtu.be/dQw4w9WgXcQ",
        "origin": "imported",
        "thumb": "https://i.ytimg.com/vi/dQw4w9WgXcQ/hqdefault.jpg",
        "thumbType": "url",
        "reactions": 87,
        "comments": 12,
        "views": 1240,
        "shares": null,
        "saves": null,
        "reach": null,
        "watchTimeMin": null,
        "avgWatchTimeSec": null,
        "engagement": 8,
        "noMetrics": false,
        "postId": null,
        "tags": [
          "testing"
        ]
      }
    ]
  },
  "reading48h": [],
  "reading48hText": "| Date | Network | Post | Views | Likes | Comments | Followers | Source |\n|---|---|---|---|---|---|---|---|",
  "collection": {
    "last": "2026-11-07T14:02:11.482Z",
    "postsWithMetrics": 6,
    "postsWithoutMetrics": 0,
    "collecting": false,
    "storedReadings": 24,
    "imported": 12,
    "lastImport": "2026-11-07T14:02:11.482Z"
  }
}
```

`null` numbers mean "the network does not report it" (never zero). Filters: `from`, `to`, `channel`, `network`, `type`, `tag`, `sort`, `page`, `limit`. `summary` and `reading48hText` are free text the server writes in Portuguese; the example shows it in English.

## Errors

No errors specific to this route besides the common ones.

### Errors on any route

| Status | code | When |
|---|---|---|
| 401 | `unauthorized` | The `Authorization: Bearer …` header is missing. |
| 401 | `invalid_api_key` | The key does not exist. |
| 401 | `revoked_api_key` | The key has been revoked. |
| 401 | `expired_api_key` | The key has expired. |
| 403 | `forbidden` | The key's scope is not enough for this route (see the scope badge). |
| 429 | `rate_limited` | The per-minute request limit was exceeded. |

The body of every error is `{ "error": { "code", "message", "details"? } }`. See [all error codes](https://praeko.app/docs/en/guides/errors-and-limits).

## Try it

> **Try it**: the live test needs you to be signed in. It is switched off here.