5centsCDN - Analytics (1.0.0)

Download OpenAPI specification:Download

filter by resource_type: stream/push/pull

filter by resource_hashes[]: array of string hashed (use /resources to get hashses)

Analytics

Resources

Authorizations:
apikeyAuth
Request Body schema: application/json
resource_type
string
  • Defines the type of resource being analyzed.
    • Determines the category of analytics data being retrieved.
    • Common values include 'push', 'cdn', 'all'.

Responses

Request samples

Content type
application/json
{
  • "resource_type": "push"
}

Response samples

Content type
application/json
{
  • "r7par989aqe9": 4543
}

Summary

Authorizations:
apikeyAuth
Request Body schema: application/json
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).

Responses

Request samples

Content type
application/json
{
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30"
}

Response samples

Content type
application/json
{
  • "summary": {
    }
}

SummaryLine

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for data aggregation.
    • Common values include:
      • '1m' (1 minute)
      • '5m' (5 minutes)
      • '15m' (15 minutes)
      • '30m' (30 minutes)
      • '1h' (1 hour)
      • '3h' (3 hours)
      • '6h' (6 hours)
      • '12h' (12 hours)
      • '24h' (24 hours, daily summary).
    • Used to determine the resolution of the analytics summary.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed.
    • Common values include:
      • 'all' (includes all available resource types). .
    • Determines the scope of the analytics report.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "info": {
    },
  • "summary": {
    },
  • "data": [
    ]
}

SummaryCard

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for grouping the analytics data.
    • Possible values: '1m' (1 minute), '5m' (5 minutes), '15m' (15 minutes), '30m' (30 minutes), '1h' (1 hour), '3h' (3 hours), '6h' (6 hours), '12h' (12 hours), '24h' (24 hours).
    • Helps determine how detailed or aggregated the data should be.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed.
    • Possible values: 'all' (all resources), 'video' (video analytics), 'playlist' (playlist analytics), 'channel' (channel-level data).
    • Helps filter analytics based on a specific category or retrieve a comprehensive overview.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "current": {
    },
  • "previous": {
    },
  • "deviation": {
    }
}

Cache

Authorizations:
apikeyAuth
Request Body schema: application/json
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).

Responses

Request samples

Content type
application/json
{
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30"
}

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

CacheLine

Authorizations:
apikeyAuth
Request Body schema: application/json
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
match
string
  • Indicates whether the query match was a 'HIT' or 'MISS'.
    • 'HIT' means the requested data was found in the cache.
    • 'MISS' would indicate the data was not found and may need to be fetched from another source.
    • Example values: 'HIT', 'MISS'.

Responses

Request samples

Content type
application/json
{
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "match": "HIT"
}

Response samples

Content type
application/json
{
  • "info": {
    },
  • "summary": {
    },
  • "data": [
    ]
}

EdgeLocation

Authorizations:
apikeyAuth
Request Body schema: application/json
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).

Responses

Request samples

Content type
application/json
{
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30"
}

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

CacheCard

Authorizations:
apikeyAuth
Request Body schema: application/json
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).

Responses

Request samples

Content type
application/json
{
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30"
}

Response samples

Content type
application/json
{
  • "current": {
    },
  • "previous": {
    },
  • "deviation": {
    }
}

EdgeLocationLine

Authorizations:
apikeyAuth
Request Body schema: application/json
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
match
string
  • Identifies a specific edge location by its unique identifier. - Typically follows a structured naming convention indicating region, country, city, and provider. - Example values include 'edge-l1-us-dal-tp01' and 'edge-l1-fr-par-cog01'.
granularity
string
  • Defines the time interval for data aggregation.
    • Common values include:
      • '1m' (1 minute)
      • '5m' (5 minutes)
      • '15m' (15 minutes)
      • '30m' (30 minutes)
      • '1h' (1 hour)
      • '3h' (3 hours)
      • '6h' (6 hours)
      • '12h' (12 hours)
      • '24h' (24 hours, daily summary).
    • Used to determine the resolution of the analytics summary.
resource_type
string
  • Specifies the type of resource being analyzed.
    • Common values include:
      • 'all' (includes all available resource types).
    • Determines the scope of the analytics report.

Responses

Request samples

Content type
application/json
{
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "match": "edge-l1-us-dal-tp01",
  • "granularity": "24h",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "info": {
    },
  • "summary": {
    },
  • "data": [
    ]
}

Country

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for data aggregation.
    • Common values include:
      • '1m' (1 minute)
      • '5m' (5 minutes)
      • '15m' (15 minutes)
      • '30m' (30 minutes)
      • '1h' (1 hour)
      • '3h' (3 hours)
      • '6h' (6 hours)
      • '12h' (12 hours)
      • '24h' (24 hours, daily summary).
    • Used to determine the resolution of the analytics summary.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed.
    • Common values include:
      • 'all' (includes all available resource types). .
    • Determines the scope of the analytics report.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

CountryLine

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for analytics data.
    • Determines how data is grouped over time.
    • Possible values: '1m', '5m', '15m', '30m', '1h', '3h', '6h', '12h', '24h'.
match
string
  • Specifies the country or region for which analytics data is being filtered.
    • Helps narrow down insights to a specific location.
    • Example values: 'India', 'United States', 'Germany'.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource for which analytics data is being retrieved.
    • Determines the scope of the data (e.g., all resources, specific categories, etc.).
    • Example values: 'all'.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "match": "India",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "info": {
    },
  • "summary": {
    },
  • "data": [
    ]
}

Browser

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for data aggregation.
    • Common values include:
      • '1m' (1 minute)
      • '5m' (5 minutes)
      • '15m' (15 minutes)
      • '30m' (30 minutes)
      • '1h' (1 hour)
      • '3h' (3 hours)
      • '6h' (6 hours)
      • '12h' (12 hours)
      • '24h' (24 hours, daily summary).
    • Used to determine the resolution of the analytics summary.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed.
    • Common values include:
      • 'all' (includes all available resource types). .
    • Determines the scope of the analytics report.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

BrowserLine

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Specifies the time interval for data aggregation.
    • Determines how detailed the analytics data should be.
    • Possible values include 'hourly', '24h' (daily), 'weekly'.
match
string
  • Defines a search pattern or query used for filtering data.
    • Commonly used for matching user-agent strings or other metadata.
    • Example values include '"Nimble/4.1.1-9"', '"Chrome/97.0"'.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed.
    • Determines whether the query applies to all resources or a specific subset.
    • Possible values include 'all', 'images', 'videos', 'documents'.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "match": "\"Nimble/4.1.1-9\"",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "info": {
    },
  • "summary": {
    },
  • "data": [
    ]
}

OS

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for data aggregation.
    • Common values include:
      • '1m' (1 minute)
      • '5m' (5 minutes)
      • '15m' (15 minutes)
      • '30m' (30 minutes)
      • '1h' (1 hour)
      • '3h' (3 hours)
      • '6h' (6 hours)
      • '12h' (12 hours)
      • '24h' (24 hours, daily summary).
    • Used to determine the resolution of the analytics summary.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed.
    • Common values include:
      • 'all' (includes all available resource types). .
    • Determines the scope of the analytics report.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

OSLIne

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for the analytics data aggregation. - Determines how detailed the data points are. - Possible values: '1m', '5m', '15m', '30m', '1h', '3h', '6h', '12h', '24h'.
match
string
  • Specifies the category or segment being analyzed. - Represents a grouping of data based on predefined criteria. - Example values: 'Other', 'Mobile', 'Desktop'.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed. - Indicates whether the data encompasses all resources or a specific type. - Example values: 'all', 'images', 'videos', 'documents'.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "match": "Other",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "info": {
    },
  • "summary": {
    },
  • "data": [
    ]
}

Device

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for data aggregation.
    • Common values include:
      • '1m' (1 minute)
      • '5m' (5 minutes)
      • '15m' (15 minutes)
      • '30m' (30 minutes)
      • '1h' (1 hour)
      • '3h' (3 hours)
      • '6h' (6 hours)
      • '12h' (12 hours)
      • '24h' (24 hours, daily summary).
    • Used to determine the resolution of the analytics summary.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed.
    • Common values include:
      • 'all' (includes all available resource types). .
    • Determines the scope of the analytics report.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

DeviceLine

Authorizations:
apikeyAuth
Request Body schema: application/json
match
string
  • Represents the device or category being analyzed.
    • This could be a general device type or a specific model.
    • Example values include 'Generic Smartphone', 'Apple iPhone', or 'Samsung Galaxy'.
granularity
string
  • Defines the time interval for data aggregation.
    • Determines how detailed the analytics data is.
    • Possible values include: '1m' (1 minute), '5m' (5 minutes), '15m' (15 minutes), '30m' (30 minutes), '1h' (1 hour), '3h' (3 hours), '6h' (6 hours), '12h' (12 hours), '24h' (24 hours).
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed.
    • Determines the category of data being retrieved.
    • Common values include: 'all' (for all resource types), 'video', 'image', 'document'.

Responses

Request samples

Content type
application/json
{
  • "match": "Generic Smartphone",
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

StatusCode

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for data aggregation.
    • Common values include:
      • '1m' (1 minute)
      • '5m' (5 minutes)
      • '15m' (15 minutes)
      • '30m' (30 minutes)
      • '1h' (1 hour)
      • '3h' (3 hours)
      • '6h' (6 hours)
      • '12h' (12 hours)
      • '24h' (24 hours, daily summary).
    • Used to determine the resolution of the analytics summary.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed.
    • Common values include:
      • 'all' (includes all available resource types). .
    • Determines the scope of the analytics report.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

StatusCodeLine

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for grouping analytics data.
    • Helps determine how detailed or summarized the data should be.
    • Possible values include:
      • '1m' (1 minute)
      • '5m' (5 minutes)
      • '15m' (15 minutes)
      • '30m' (30 minutes)
      • '1h' (1 hour)
      • '3h' (3 hours)
      • '6h' (6 hours)
      • '12h' (12 hours)
      • '24h' (24 hours, daily summary).
match
integer
  • Represents an HTTP status code to filter analytics results.
    • Typically used to track successful or failed requests.
    • Example values include:
      • 200 (OK - successful requests)
      • 404 (Not Found - missing resources)
      • 500 (Internal Server Error - server failure).
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed.
    • Helps filter analytics data based on resource categories.
    • Example values include:
      • 'all' (analyze all resources)
      • 'images' (only image files)
      • 'videos' (only video files).

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "match": 200,
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "info": {
    },
  • "summary": {
    },
  • "data": [
    ]
}

Referrer

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for data aggregation.
    • Common values include:
      • '1m' (1 minute)
      • '5m' (5 minutes)
      • '15m' (15 minutes)
      • '30m' (30 minutes)
      • '1h' (1 hour)
      • '3h' (3 hours)
      • '6h' (6 hours)
      • '12h' (12 hours)
      • '24h' (24 hours, daily summary).
    • Used to determine the resolution of the analytics summary.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed.
    • Common values include:
      • 'all' (includes all available resource types). .
    • Determines the scope of the analytics report.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

ReferrerLine

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for data aggregation.
    • Common values include:
      • '1m' (1 minute)
      • '5m' (5 minutes)
      • '15m' (15 minutes)
      • '30m' (30 minutes)
      • '1h' (1 hour)
      • '3h' (3 hours)
      • '6h' (6 hours)
      • '12h' (12 hours)
      • '24h' (24 hours)
    • Determines the level of detail for analytics reporting.
match
string
  • Represents a filtering or grouping criterion for analytics data.
    • Can be a specific keyword, identifier, or wildcard ('-') for general data.
    • Example values:
      • '"-"' (no specific match, general data)
      • 'example.com' (specific referrer domain)
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the category of resources being analyzed.
    • Can be 'all' for overall analytics or a specific type such as:
      • 'images' (image files)
      • 'videos' (video files)
      • 'documents' (text-based files like PDFs)
    • Helps refine analytics to focus on a particular content type.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "match": "\"-\"",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "info": {
    },
  • "summary": {
    },
  • "data": [
    ]
}

File

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for data aggregation.
    • Common values include:
      • '1m' (1 minute)
      • '5m' (5 minutes)
      • '15m' (15 minutes)
      • '30m' (30 minutes)
      • '1h' (1 hour)
      • '3h' (3 hours)
      • '6h' (6 hours)
      • '12h' (12 hours)
      • '24h' (24 hours, daily summary).
    • Used to determine the resolution of the analytics summary.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed.
    • Common values include:
      • 'all' (includes all available resource types). .
    • Determines the scope of the analytics report.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

FileLine

Authorizations:
apikeyAuth
Request Body schema: application/json
match
string
  • The specific file or resource being analyzed. - Represents a file path or URL related to analytics tracking. - Example values include video segment files, image assets, or other media content. - Example paths: - '/mp4/raw/1/1/4-f458d0d0-7e67-4fab-a61e-230a31ad82b2_combined.smil/seg-2-v3-a1.ts' - '/assets/images/banner-ad.png'
granularity
string
  • The time interval used for data aggregation. - Determines how detailed the analytics data is. - Possible values: - '1m' (1 minute) - '5m' (5 minutes) - '15m' (15 minutes) - '30m' (30 minutes) - '1h' (1 hour) - '3h' (3 hours) - '6h' (6 hours) - '12h' (12 hours) - '24h' (24 hours) - Example: '24h' means data is grouped into 24-hour periods.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • The type of resource being analyzed. - Defines the category of the resource being tracked. - Possible values: - 'all' (Includes all types of resources) - 'video' (Only video-related resources) - 'image' (Only image-based resources) - 'document' (PDFs, text files, etc.) - Example: 'all' means analytics cover every type of resource, while 'video' focuses only on video files.

Responses

Request samples

Content type
application/json
{
  • "match": "/mp4/raw/1/1/4-f458d0d0-7e67-4fab-a61e-230a31ad82b2_combined.smil/seg-2-v3-a1.ts",
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "info": {
    },
  • "summary": {
    },
  • "data": [
    ]
}

Visitor

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for data aggregation.
    • Common values include:
      • '1m' (1 minute)
      • '5m' (5 minutes)
      • '15m' (15 minutes)
      • '30m' (30 minutes)
      • '1h' (1 hour)
      • '3h' (3 hours)
      • '6h' (6 hours)
      • '12h' (12 hours)
      • '24h' (24 hours, daily summary).
    • Used to determine the resolution of the analytics summary.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed.
    • Common values include:
      • 'all' (includes all available resource types). .
    • Determines the scope of the analytics report.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

VisitorLine

Authorizations:
apikeyAuth
Request Body schema: application/json
match
string
  • The IP address or identifier used to filter analytics data.
    • Represents a specific user, device, or network accessing the system.
    • Example values include IP addresses like '198.144.159.121' or user identifiers like 'user-1234'.
granularity
string
  • Defines the time interval for aggregating analytics data.
    • Determines how detailed or summarized the data points are.
    • Possible values include:
      • '1m' (1 minute)
      • '5m' (5 minutes)
      • '15m' (15 minutes)
      • '30m' (30 minutes)
      • '1h' (1 hour)
      • '3h' (3 hours)
      • '6h' (6 hours)
      • '12h' (12 hours)
      • '24h' (24 hours, daily summary).
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed in the analytics data.
    • Can be used to filter data based on specific resource categories.
    • Common values include:
      • 'all' (default, includes all resources)
      • 'images' (only image-related traffic)
      • 'videos' (only video-related traffic)
      • 'documents' (only document-related traffic).

Responses

Request samples

Content type
application/json
{
  • "match": "198.144.159.121",
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "info": {
    },
  • "summary": {
    },
  • "data": [
    ]
}

ASN

Authorizations:
apikeyAuth
Request Body schema: application/json
granularity
string
  • Defines the time interval for data aggregation.
    • Common values include:
      • '1m' (1 minute)
      • '5m' (5 minutes)
      • '15m' (15 minutes)
      • '30m' (30 minutes)
      • '1h' (1 hour)
      • '3h' (3 hours)
      • '6h' (6 hours)
      • '12h' (12 hours)
      • '24h' (24 hours, daily summary).
    • Used to determine the resolution of the analytics summary.
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • Specifies the type of resource being analyzed.
    • Common values include:
      • 'all' (includes all available resource types). .
    • Determines the scope of the analytics report.

Responses

Request samples

Content type
application/json
{
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "data": [
    ]
}

ASNLine

Authorizations:
apikeyAuth
Request Body schema: application/json
match
string
  • The entity to match against, such as a specific organization or service provider.
    • Common values include major service providers like 'GOOGLE' or 'AMAZON'.
    • This helps filter analytics data for a specific source.
granularity
string
  • The level of time detail for the analytics data.
    • Determines how data is segmented over time.
    • Possible values: '1m' (1 minute), '5m' (5 minutes), '15m' (15 minutes), '30m' (30 minutes), '1h' (1 hour), '3h' (3 hours), '6h' (6 hours), '12h' (12 hours), '24h' (24 hours).
r
string
  • Specifies the date range for which analytics data is requested.
    • Format: 'YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS' (UTC/GMT).
    • Represents the start and end times of the data retrieval period in Coordinated Universal Time (UTC) / Greenwich Mean Time (GMT).
    • Example values:
      • '2025-02-01 00:00:00 - 2025-02-06 09:42:30' (5-day range, UTC/GMT).
      • '2024-12-15 12:00:00 - 2024-12-20 18:30:45' (custom period, UTC/GMT).
resource_type
string
  • The type of resource being analyzed.
    • Determines whether the analytics data covers all resources or specific ones.
    • Possible values: 'all' (includes all resources), 'video', 'image', 'document'.

Responses

Request samples

Content type
application/json
{
  • "match": "GOOGLE",
  • "granularity": "24h",
  • "r": "2025-02-01 00:00:00 - 2025-02-06 09:42:30",
  • "resource_type": "all"
}

Response samples

Content type
application/json
{
  • "info": {
    },
  • "summary": {
    },
  • "data": [
    ]
}