Analytics

The Analytics API gives you detailed insights into video performance, user engagement, and content effectiveness. You can filter data by organization, entitlements, watch history, and key engagement metrics to track viewership trends and measure content impact. Whether you need high-level summaries or granular breakdowns, this API gives you the flexibility to drive data-driven content optimization and monetization strategies.

Endpoint

GET https://external.parone.io/v2/analytics/{type}?startDate={startDate}&endDate={endDate}

Request Parameters

Parameter	Type	Description
`type`	string (required)	The type of analytics data to retrieve (e.g., `video`, `ads`, `livestream`).
`summary` or `detailed`	string (required)	Use `summary` for aggregated totals over the date range or `detailed` for breakdowns by day and `content-key`.
`startDate`	string (required, format: `YYYY-MM-DD`)	The start date for the analytics data.
`endDate`	string (required, format: `YYYY-MM-DD`)	The end date for the analytics data.
`fields`	array of strings (optional)	Specify which analytics metrics to retrieve. Options: `played_1`, `played_30`.

`categories`

type: array of strings

The categories parameter allows you to filter videos by specific categories assigned to them. By providing an array of strings, you can narrow down the video selection to those matching the specified categories. This is helpful when you need to organize videos based on custom groupings.

curl -H "authorization: your-api-key" \
  "https://external.parone.io/v2/videos?categories=golf"

`customFields`

type: array of strings

You can filter videos based on custom fields using the customFields parameter. This allows you to specify a list of custom field entries that should match the video metadata. It provides flexibility for filtering content according to non-standard attributes set by your video library.

`events`

type: array of strings

The events parameter filters videos by specific events that are associated with them. By passing an array of event names or IDs, you can ensure that only videos tied to particular events are returned. This is useful for event-driven content filtering, such as tournaments or promotional events.

`feedId`

type: string

The feedId parameter allows you to filter videos by a specific feed. If no feedId is provided, all available videos across all feeds will be returned. This makes it easy to query videos belonging to a particular feed for targeted delivery.

`mmi`

type: string

Use the mmi parameter to filter videos by a specific MMI (Media Management Identifier). This can be helpful when you need to isolate videos related to a certain sub-organization.

`networkVideos`

type: boolean

The networkVideos parameter determines whether or not to return entitled network syndication videos. By setting this to true, you’ll retrieve network-related videos; false limits results to just your organization’s videos.

`searchString`

type: string

The searchString parameter filters videos by matching titles, descriptions, or content keys. This allows users to search for videos that contain specific keywords or phrases, improving the efficiency of content discovery. It is particularly useful for finding relevant videos quickly without needing to know exact metadata. You must have at least characters.

`tags`

type: array of strings

The tags parameter enables filtering of videos based on custom tags assigned to them. By passing an array of tags, you can narrow down the search to videos that have the specified tags, making it easier to categorize and retrieve videos based on specific keywords or themes.

`page`

type: integer

The page parameter allows you to specify which page of results you want to retrieve when paginating through a large set of videos. This is useful for breaking down large sets of data into manageable chunks, ensuring your application can load and display results without overwhelming the user interface.

`pageSize`

type: integer

The pageSize parameter sets the number of videos returned per page. By adjusting this value, you control the pagination size, which helps optimize performance and user experience when displaying video results. This parameter allows you to fine-tune the number of items shown in each batch of API responses.

Success Response

This call will return a JSON object that has a list of videos for your organization.

{
  "count": 2,
  "message": "400",
  "data": [
    {
      "contentKey": "EdSGJ6kC",
      "createdDate": "2022-08-22T19:54:50.122Z",
      "publishedDate": "2022-08-22T19:54:50.122Z",
      "title": "Can the new Callaway Rogue ST Pro irons outperform Apex irons? | Proving Ground ClubTest 2022",
      "description": "The Callaway Golf Rogue ST irons are meant to serve as a successor to the Mavrik line",
      "duration": "70",
      "paroneCategories": [],
      "categories": [],
      "tags": [],
      "events": [],
      "customFields": [],
      "isLive": false,
      "thumbnail": "https://thumbnails.parone.io/EdSGJ6kC.jpg",
			"url": "https://ingest.parone.io/video-1080p.mp4",
      "urlHLS": "https://cdn1.parone.io/video.m3u8",
    },
    {
		  "contentKey": "EdSGJ6kC",
		  "createdDate": "2022-08-22T19:54:50.122Z",
		  "publishedDate": "2022-08-22T19:54:50.122Z",
		  "title": "Can the new Callaway Rogue ST Pro irons outperform Apex irons? | Proving Ground ClubTest 2022",
		  "description": "The Callaway Golf Rogue ST irons are meant to serve as a successor to the Mavrik line",
		  "duration": "70",
		  "paroneCategories": [],
		  "categories": [],
		  "tags": [],
		  "events": [],
		  "customFields": [],
		  "isLive": false,
		  "thumbnail": "https://thumbnails.parone.io/EdSGJ6kC.jpg",
			"url": "https://ingest.parone.io/video-1080p.mp4",
		  "urlHLS": "https://cdn1.parone.io/video.m3u8",
		}
  ]
}

Structure of the Returned Results

Field	Value
`count`	The total number of videos matching the query. Defaults to 100 if no limit is specified.
`contentKey`	A unique identifier assigned to each video.
`createdDate`	The date and time when the video was first created in the system.
`publishedDate`	The date and time when the video was published and made available to users.
`title`	The official title of the video.
`description`	A brief summary or overview of the video’s content.
`duration`	The total runtime of the video in seconds.
`paroneCategories`	The syndicated categories assigned to the video within the ParOne system.
`categories`	Keywords or labels that help describe and categorize the video.
`tags`	Keywords or labels that the video has tagged
`events`	Any relevant events associated with the video, such as tournaments or special broadcasts.
`customFields`	A collection of additional metadata fields that may vary based on the organization’s needs.
`isLive`	Indicates whether the video is a live stream (`true`) or a pre-recorded video (`false`).
`thumbnail`	The URL of the video’s thumbnail image. See Image Optimization
`url`	The direct URL to download the video file.
`urlHLS`	The HLS (HTTP Live Streaming) URL for adaptive streaming playback.