Перейти к содержимому
Telegfy

Get account-level analytics overview

GET
/api/v1/analytics/overview
curl --request GET \
  --url 'https://example.com/api/v1/analytics/overview?from=2026-02-22T00%3A00%3A00Z&to=2026-03-01T23%3A59%3A59Z&granularity=hour' \
  --header 'Authorization: Bearer <token>'

Authorizations

Заголовок раздела «Authorizations»

Parameters

Заголовок раздела «Parameters»

Query Parameters

Заголовок раздела «Query Parameters»
from
string

Example 

2026-02-22T00:00:00Z

Start date (ISO 8601). Default: 7 days ago

to
string

Example 

2026-03-01T23:59:59Z

End date (ISO 8601). Default: now

granularity
string
default: day
Allowed values: hour day week month

Responses

Заголовок раздела «Responses»

200

Заголовок раздела «200»
Media typeapplication/json
object
totalLinks
required
number
activeLinks
required
number
totalClicks
required
number
clicksToday
required
number
clicksYesterday
required
number
clicksThisWeek
required
number
clicksPrevWeek
required
number
clicksThisMonth
required
number
clicksPrevMonth
required
number
from
required
string
to
required
string
topLinks
required
Array<object>
object
linkId
required
string
shortCode
required
string
customAlias
object
originalUrl
required
string
clicks
required
number
timeseries
required
Array<object>
object
period
required
string
totalClicks
required
number
uniqueClicks
required
number
topCountries
required
Array<object>
object
countryCode
required
string
countryName
required
string
clicks
required
number
percentage
required
number
referrers
required
Array<object>
object
domain
required
string
clicks
required
number
percentage
required
number
devices
required
object
deviceTypes
required
Array<object>
object
type
required
string
clicks
required
number
percentage
required
number
browsers
required
Array<object>
object
browser
required
string
clicks
required
number
percentage
required
number
operatingSystems
required
Array<object>
object
os
required
string
clicks
required
number
percentage
required
number

Example generated

{
  "totalLinks": 1,
  "activeLinks": 1,
  "totalClicks": 1,
  "clicksToday": 1,
  "clicksYesterday": 1,
  "clicksThisWeek": 1,
  "clicksPrevWeek": 1,
  "clicksThisMonth": 1,
  "clicksPrevMonth": 1,
  "from": "example",
  "to": "example",
  "topLinks": [
    {
      "linkId": "example",
      "shortCode": "example",
      "customAlias": {},
      "originalUrl": "example",
      "clicks": 1
    }
  ],
  "timeseries": [
    {
      "period": "example",
      "totalClicks": 1,
      "uniqueClicks": 1
    }
  ],
  "topCountries": [
    {
      "countryCode": "example",
      "countryName": "example",
      "clicks": 1,
      "percentage": 1
    }
  ],
  "referrers": [
    {
      "domain": "example",
      "clicks": 1,
      "percentage": 1
    }
  ],
  "devices": {
    "deviceTypes": [
      {
        "type": "example",
        "clicks": 1,
        "percentage": 1
      }
    ],
    "browsers": [
      {
        "browser": "example",
        "clicks": 1,
        "percentage": 1
      }
    ],
    "operatingSystems": [
      {
        "os": "example",
        "clicks": 1,
        "percentage": 1
      }
    ]
  }
}