Skip to main content

Frequency Documentation

Endpoints

Hostname

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

Retrieve Series

Endpoint

GET /series

Parameters

Data Type

Example

page_size

Integer

Maximum results per page (optional)

page_size=30

page_offset

String

The page_mark value from the previous page (optional)

Request

Headers

"X-Frequency-DeviceId": "d9d7465c2341014f26a87629be46639e"
"X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2"
"Content-Type": "application/json"

Response

Body

Retrieve specific series metadata

GET /series/series_id

Request

Headers

"X-Frequency-DeviceId": "d9d7465c2341014f26a87629be46639e"
"X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2"
"Content-Type": "application/json"

Response

Body

Retrieve all videos

GET /videos

Parameters

Data Type

Example

media_type

String

Return media_url for HLS or MP4

media_type=hls

page_size

Integer

Maximum results per page (optional)

page_size=30

page_offset

String

The page_mark value from the previous page (optional)

page_mark=6798629928574052699

Request

Headers

"X-Frequency-DeviceId": "d9d7465c2341014f26a87629be46639e"
"X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2"
"Content-Type": "application/json"

Response

Body

Retrieve specific video metadata

GET /videos/<video_id>

Parameter

Data Type

Example

media_type

String

Return media_url for HLS or MP4

media_type=hls

Request

Headers

"X-Frequency-DeviceId": "d9d7465c2341014f26a87629be46639e"
"X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2"
"Content-Type": "application/json"

Response

Body

Retrieve videos from specific series

GET /series/<series_id>/videos

Parameter

Data Type

Example

media_type

String

Return media_url for HLS or MP4

media_type=hls

episode

Integer

episode=1

sort

String

sort=episode_number.DESC

Sort field names by ascending (ASC) or descending (DESC)

Supported field names:

  • episode_number

  • last_updated

page_size

Integer

Maximum results per page (optional)

page_size=30

page_offset

String

The page_mark value from the previous page (optional)

page_mark=6798629928574052699

Request

Headers

"X-Frequency-DeviceId": "d9d7465c2341014f26a87629be46639e"
"X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2"
"Content-Type": "application/json"

Response

Body

Search video (simple)

POST /search/videos

Parameter

Data Type

Example

media_type

String

Return media_url for HLS or MP4

media_type=hls

page_size

String

The page_mark value from the previous page (optional)

page_mark=6798629928574052699

page_offset

Integer

Maximum results per page (optional)

page_size=30

Request

Headers

"X-Frequency-DeviceId": "d9d7465c2341014f26a87629be46639e"
"X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2"
"Content-Type": "application/json"

Payload

{
    "query": "\"baseball\""
}

Response

Body

Search video (advanced)

POST /search/videos

Parameter

Data Type

Example

media_type

String

Return media_url for HLS or MP4

media_type=hls

page_size

String

The page_mark value from the previous page (optional)

page_mark=6798629928574052699

page_offset

Integer

Maximum results per page (optional)

page_size=30

Request

Headers

"X-Frequency-DeviceId": "d9d7465c2341014f26a87629be46639e"
"X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2"
"Content-Type": "application/json"

Payload

{
    "query": "\"baseball\"",
    "fields": [],
    "filter": {
        "and": [{
            "and": [{
                "gte": {
                    "date_published": "#{subdate(now(),3d)}"
                }
            }]
        }, {
            "in": {
                "channel_id": ["6727647811228035"]
            }
        }, {
            "and": [{
                "lte": {
                    "duration": 1500
                }
            }]
        }]
    },
    "sort": {
        "field": "last_updated",
        "order": "DESC"
    }
}

Response

Body

Retrieve all playlists

GET /playlists

Parameter

Data Type

Example

page_size

String

The page_mark value from the previous page (optional)

page_mark=6798629928574052699

page_offset

Integer

Maximum results per page (optional)

page_size=30

Request

Headers

"X-Frequency-DeviceId": "d9d7465c2341014f26a87629be46639e"
"X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2"
"Content-Type": "application/json"

Response

Body

Retrieve specific playlist metadata

GET /playlists/<playlist_id>

Request

Headers

"X-Frequency-DeviceId": "d9d7465c2341014f26a87629be46639e"
"X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2"
"Content-Type": "application/json"

Response

Body

Retrieve videos for a specific playlist

GET /playlists/<playlist_id>/videos

Parameter

Data Type

Example

page_size

String

The page_mark value from the previous page (optional)

page_mark=6798629928574052699

page_offset

Integer

Maximum results per page (optional)

page_size=30

Request

Headers

"X-Frequency-DeviceId": "d9d7465c2341014f26a87629be46639e"
"X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2"
"Content-Type": "application/json"

Response

Body

Ingest videos and schedule in channel

POST /automation/schedule

Request

Headers

"X-Frequency-DeviceId": "d9d7465c2341014f26a87629be46639e"
"X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2"
"Content-Type": "application/json"

Payload

{
    "linear_channel_id": "78",
    "source_id": "6291431901791729322",
    "brand_id": "6429846635265866447",
    "program_title": "Linear Program Title",
    "program_description": "Linear Program Description",
    "videos": [{
        "video_source_id": "123456",
        "title": "Video1 Title",
        "description": "Video1 Description",
        "keywords": "one,two,three, four, five",
        "date_published": "2020-12-05T01:23:45Z",
        "image_url": "https://my.server.com/content/video1-thumbnail.jpg",
        "video_url": "https://my.server.com/content/video1.mp4",
        "duration": 20000,
        "genres": [{
            "genre": "Travel",
            "sub_genre": "Africa"
        }, {
            "genre": "Travel",
            "sub_genre": "Outdoors"
        }],
        "audio_language": "en",
        "country_origin": "US",
        "content_format": "Movie",
        "content_type": "Recipes",
        "cut": "Clip",
        "periodicity": "Daily",
        "parental_rating": "Child",
        "type": "VIDEO"
    }, {
        "duration": 20000,
        "type": "AD_POD"
    }, {
        "video_source_id": "123456",
        "title": "Video2 Title",
        "description": "Video2 Description",
        "image_url": "https://my.server.com/content/video2-thumbnail.jpg",
        "video_url": "https://my.server.com/content/video2.mp4",
        "duration": 20000,
        "genres": [{
            "genre": "Travel",
            "sub_genre": "Africa"
        }, {
            "genre": "Travel",
            "sub_genre": "Outdoors"
        }],
        "audio_language": "en",
        "country_origin": "US",
        "content_format": "Movie",
        "content_type": "Recipes",
        "cut": "Clip",
        "periodicity": "Daily",
        "parental_rating": "Child",
        "type": "VIDEO"
    }],
    "schedule": {
        "start_time": "2020-11-10T13:00:00Z",
        "duration_ms": 40000
    }
}

Response

Body

{
  "request_id": "1",
  "message": "Schedule Added for processing"
}

Field Notes

Troubleshooting