Skip to main content

Frequency Documentation

Reporting

Hostname

https://prd-freq.frequency.com/api/2.3

Asset-level Minutes Watched

Returns information of how many minutes an asset was watched by the minute/hour. This excludes components like ad pods and interstitials within a program, and includes information about the channel and distributor it was watched in.

Fields returned: timestamp, linear_channel_id, linear_channel_name, distributor, brand_name, series_name, video_id, video_title, video_description, external_video_id, minutes_watched

Endpoint

GET /reports/analytics

Parameters

Description

Data Type

Example

from

Required. Start date of reports, returned daily.

date(yyyy-mm-dd)

from=2023-11-01

to

Required. End date of reports, returned daily.

date(yyyy-mm-dd)

to=2023-11-05

time_frame

Optional. Granularity of data returned in the reports. Default is hour.

string(hour, minute)

time_frame=minute

Request

Example

curl --location --request GET 'https://prd-freq.frequency.com/api/2.3/reports/analytics?from=2023-09-01&to=2023-09-03&time_frame=hour' \
--header 'Content-Type: application/json' \
--header 'x-frequency-auth: dd61135eba-2c1cc8e4-37cc5e-3d54e0c2' \
--header 'x-frequency-deviceid: 8b7f9c2d-4a16-b8e5'

Response

Body

Interstitials Minutes Watched

Returns information of how many minutes interstitial assets were watched by the day. This excludes components like ad pods and interstitials within a program, and includes information about the channel and distributor it was watched in.

FIelds returned: timestamp, component_reference_id, component_title, program_id, program_title, distributor, minutes_watched

Endpoint

GET /reports/analytics/interstitials

Parameters

Description

Data Type

Example

from

Required. Start date of reports, returned daily.

date(yyyy-mm-dd)

from=2023-11-01

to

Required. End date of reports, returned daily.

date(yyyy-mm-dd)

to=2023-11-05

Request

Example

curl --location --request GET 'https://prd-freq.frequency.com/api/2.3/reports/analytics/interstitials?from=2023-09-01&to=2023-09-03' \
--header 'Content-Type: application/json' \
--header 'x-frequency-auth: dd61135eba-2c1cc8e4-37cc5e-3d54e0c2' \
--header 'x-frequency-deviceid: 8b7f9c2d-4a16-b8e5'

Response

Body

Program Level Scheduling

Returns the linear programs that were scheduled by channel and time.

Fields returned: linear_channel_id, linear_channel_name, program_start_time, program_end_time, program_duration, program_id, program_title, program_description, series_name, season_number, episode_number, video_id

Endpoint

GET /reports/program/schedules

Parameters

Description

Data Type

Example

from

Required. Start date of reports, returned daily.

date(yyyy-mm-dd)

from=2023-11-01

to

Required. End date of reports, returned daily.

date(yyyy-mm-dd)

to=2023-11-05

Request

Example

curl --location --request GET 'https://prd-freq.frequency.com/api/2.3/reports/program/schedules?from=2023-09-01&to=2023-09-03' \
--header 'Content-Type: application/json' \
--header 'x-frequency-auth: dd61135eba-2c1cc8e4-37cc5e-3d54e0c2' \
--header 'x-frequency-deviceid: 8b7f9c2d-4a16-b8e5'

Response

Body

Component Level Scheduling

Returns the precise start time of every component within a linear program that was scheduled (videos, ad pods, interstitials, time fill).

Fields returned: linear_channel_id, linear_channel_name, program_start_time, program_end_time, program_duration, program_id, program_title, component_type, component_start_time, component_duration, component_reference_id, component_title, series_name, season_number, episode_number

Endpoint

GET /reports/component/schedules

Parameters

Description

Data Type

Example

from

Required. Start date of reports, returned daily.

date(yyyy-mm-dd)

from=2023-11-01

to

Required. End date of reports, returned daily.

date(yyyy-mm-dd)

to=2023-11-05

Request

Example

curl --location --request GET 'https://prd-freq.frequency.com/api/2.3/reports/component/schedules?from=2023-09-01&to=2023-09-03' \
--header 'Content-Type: application/json' \
--header 'x-frequency-auth: dd61135eba-2c1cc8e4-37cc5e-3d54e0c2' \
--header 'x-frequency-deviceid: 8b7f9c2d-4a16-b8e5'

Response

Body

Channel Start Count

Returns the number of channel starts per hour by distributor and channel.

Fields returned: timestamp, linear_channel_name, distributor, channel_starts

Endpoint

GET /reports/analytics/channels

Parameters

Description

Data Type

Example

from

Required. Start date of reports, returned daily.

date(yyyy-mm-dd)

from=2023-11-01

to

Required. End date of reports, returned daily.

date(yyyy-mm-dd)

to=2023-11-05

Request

Example

curl --location --request GET 'https://prd-freq.frequency.com/api/2.3/reports/analytics/channels?from=2023-09-01&to=2023-09-03' \
--header 'Content-Type: application/json' \
--header 'x-frequency-auth: dd61135eba-2c1cc8e4-37cc5e-3d54e0c2' \
--header 'x-frequency-deviceid: 8b7f9c2d-4a16-b8e5'

Response

Body