Endpoints

Metadata

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)

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-Device": "d9d7465c2341014f26a87629be46639e" "X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2" "Content-Type": "application/json"
Body Expand { "series": [{ "series_id": "12341241", "series_title": "NH Chronicle", "series_description": "Series description" "seasons": [{ "season_number": 1, "season_title": "Season One", "season_description": "Episode description" "episodes": [{ "episode_number": 1, "episode_title": "Baseball Card Collector", "episode_description": "Episode description" }, { "episode_number": 2, "episode_title": "Stamps Collector", "episode_description": "Episode description" } ] }], "seasons": [{ "season_number": 2, "season_title": "Season Two", "season_description": "" "episodes": [] }] }] "page": { "page_size": 30, "page_offset": "6798629928574052699", "page_mark": "6798629928574052699" } } "seasons": [{ "season_number": 2, "season_title": "Season Two", "season_description": "Season desc, when applicable", "episodes": [] }] }

Request

Headers

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

Response

Body

{
    "series": [{
        "series_id": "12341241",
        "series_title": "NH Chronicle",
        "series_description": "Series description"
        "seasons": [{
            "season_number": 1,
            "season_title": "Season One",
            "season_description": "Episode description"
            "episodes": [{
                    "episode_number": 1,
                    "episode_title": "Baseball Card Collector",
                    "episode_description": "Episode description"
                },
                {
                    "episode_number": 2,
                    "episode_title": "Stamps Collector",
                    "episode_description": "Episode description"
                }
            ]
        }],
        "seasons": [{
            "season_number": 2,
            "season_title": "Season Two",
            "season_description": ""
            "episodes": []
        }]
    }]
    "page": {
        "page_size": 30,
        "page_offset": "6798629928574052699",
        "page_mark": "6798629928574052699"
    }
}   "seasons": [{
        "season_number": 2,
        "season_title": "Season Two",
        "season_description": "Season desc, when applicable",
        "episodes": []
    }]
}

Retrieve specific series metadata

GET /series/series_id

Request
Headers "X-Frequency-Device": "d9d7465c2341014f26a87629be46639e" "X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2" "Content-Type": "application/json"
Body Expand { "series_id": "12341241", "series_title": "NH Chronicle", "series_description": "Series description", "seasons": [{ "season_number": 1, "season_title": "Season One", "season_description": "Season desc, when applicable", "episodes": [{ "episode_number": 1, "episode_title": "Baseball Card Collector", "episode_description": "Episode description" }, { "episode_number": 2, "episode_title": "Stamps Collector", "episode_description": "" } ] }], "seasons": [{ "season_number": 2, "season_title": "Season Two", "season_description": "Season desc, when applicable", "episodes": [] }] }

Request

Headers

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

Response

Body

{
    "series_id": "12341241",
    "series_title": "NH Chronicle",
    "series_description": "Series description",
    "seasons": [{
        "season_number": 1,
        "season_title": "Season One",
        "season_description": "Season desc, when applicable",
        "episodes": [{
                "episode_number": 1,
                "episode_title": "Baseball Card Collector",
                "episode_description": "Episode description"
            },
            {
                "episode_number": 2,
                "episode_title": "Stamps Collector",
                "episode_description": ""
            }
        ]
    }],
    "seasons": [{
        "season_number": 2,
        "season_title": "Season Two",
        "season_description": "Season desc, when applicable",
        "episodes": []
    }]
}

Videos

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-Device": "d9d7465c2341014f26a87629be46639e" "X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2" "Content-Type": "application/json"
Body Expand { "videos": [{ "video_id": "6798629928574052699", "video_source_id": "content-partner-video-id-1234", "title": "NH Chronicle: Baseball Card Collector", "description": "The great ballplayers of the Negro Leagues", "keywords": "chronicle,baseball,collectibles", "parental_rating": "TV14", "age_rating": 14, "genres": [{ "genre": "News", "sub_genre": "" }], "region": { "key": "US", "regionName": "United States" }, "language": { "code": "en", "name": "English" }, "brand_id": "67085422112246934", "duration": 1215, "duration_ms": 1215305, "ad_cue_points": [584234, 994334, 1173834], "source": "Hearst", "content_format": "Show", "content_type": "Episode", "series": { "series_id": "12341241", "series_title": "NH Chronicle", "series_description": "Series description", "season_number": 1, "season_title": "Season One", "season_description": "Season description", "episode_number": 1, "episode_title": "Baseball Card Collector", "season_description": "Season description" }, "movie": { "movie_id": null, "movie_title": "", "movie_description": "" }, "image_url": "https://images.frequency.com/video/10lnuqbezq0ue1k70/original/10lnuquk1c07i09e1k70.jpg", "media_type": "hls", "media_url": "https://media.frequency.com/videos/212541212123123/HK_JclkpQoiX.m3u8", "subtitles": [{ "language": "en", "subtitle_": "https://subtitles.frequency.com/21254121923123/es/srt/162633312F65EF30AE8_Converted.srt", "type": "SRT" }], "last_updated": "2021-05-20T07:21:47Z", "date_expired": null, "date_publish": "2021-05-13T15:46:26Z", "date_created": "2021-05-13T15:46:26Z" }], "page": { "page_size": 30, "page_offset": "6798629928574052699", "page_mark": "6798629928574052699" } }

Request

Headers

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

Response

Body

{
    "videos": [{
        "video_id": "6798629928574052699",
        "video_source_id": "content-partner-video-id-1234",
        "title": "NH Chronicle: Baseball Card Collector",
        "description": "The great ballplayers of the Negro Leagues",
        "keywords": "chronicle,baseball,collectibles",
        "parental_rating": "TV14",
        "age_rating": 14,
        "genres": [{
            "genre": "News",
            "sub_genre": ""
        }],
        "region": {
            "key": "US",
            "regionName": "United States"
        },
        "language": {
            "code": "en",
            "name": "English"
        },
        "brand_id": "67085422112246934",
        "duration": 1215,
        "duration_ms": 1215305,
        "ad_cue_points": [584234, 994334, 1173834],
        "source": "Hearst",
        "content_format": "Show",
        "content_type": "Episode",
        "series": {
            "series_id": "12341241",
            "series_title": "NH Chronicle",
            "series_description": "Series description",
            "season_number": 1,
            "season_title": "Season One",
            "season_description": "Season description",
            "episode_number": 1,
            "episode_title": "Baseball Card Collector",
            "season_description": "Season description"
        },
        "movie": {
            "movie_id": null,
            "movie_title": "",
            "movie_description": ""
        },
       "image_url": "https://images.frequency.com/video/10lnuqbezq0ue1k70/original/10lnuquk1c07i09e1k70.jpg",
        "media_type": "hls",
        "media_url": "https://media.frequency.com/videos/212541212123123/HK_JclkpQoiX.m3u8",
        "subtitles": [{
            "language": "en",
            "subtitle_": "https://subtitles.frequency.com/21254121923123/es/srt/162633312F65EF30AE8_Converted.srt",
            "type": "SRT"
        }],
        "last_updated": "2021-05-20T07:21:47Z",
        "date_expired": null,
        "date_publish": "2021-05-13T15:46:26Z",
        "date_created": "2021-05-13T15:46:26Z"
    }],
    "page": {
        "page_size": 30,
        "page_offset": "6798629928574052699",
        "page_mark": "6798629928574052699"
    }
}

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-Device": "d9d7465c2341014f26a87629be46639e" "X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2" "Content-Type": "application/json"
Body Expand { "video_id": "6798629928574052699", "video_source_id": "content-partner-video-id-1234", "title": "NH Chronicle: Baseball Card Collector", "description": "The great ballplayers of the Negro Leagues", "keywords": "chronicle,baseball,collectibles", "parental_rating": "TV14", "age_rating": 14, "genres": [{ "genre": "News", "sub_genre": "" }], "region": { "key": "US", "regionName": "United States" }, "language": { "code": "en", "name": "English" }, "brand_id": "67085422112246934", "duration": 1215, "duration_ms": 1215305, "ad_cue_points": [584234, 994334, 1173834], "source": "Hearst", "content_format": "Show", "content_type": "Episode", "series": { "series_id": "12341241", "series_title": "NH Chronicle", "series_description": "Series description", "season_number": 1, "season_title": "Season One", "season_description": "Season description", "episode_number": 1, "episode_title": "Baseball Card Collector", "season_description": "Season description" }, "movie": { "movie_id": null, "movie_title": "", "movie_description": "" }, "image_url": "https://images.frequency.com/video/10lnuqbezq0ue1k70/original/10lnuquk1c07i09e1k70.jpg", "media_type": "hls", "media_url": "https://media.frequency.com/videos/212541212123123/HK_JclkpQoiX.m3u8", "subtitles": [{ "language": "en", "subtitle_": "https://subtitles.frequency.com/21254121923123/es/srt/162633312F65EF30AE8_Converted.srt", "type": "SRT" }], "last_updated": "2021-05-20T07:21:47Z", "date_expired": null, "date_publish": "2021-05-13T15:46:26Z", "date_created": "2021-05-13T15:46:26Z" }

Request

Headers

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

Response

Body

{
    "video_id": "6798629928574052699",
    "video_source_id": "content-partner-video-id-1234",
    "title": "NH Chronicle: Baseball Card Collector",
    "description": "The great ballplayers of the Negro Leagues",
    "keywords": "chronicle,baseball,collectibles",
    "parental_rating": "TV14",
    "age_rating": 14,
    "genres": [{
        "genre": "News",
        "sub_genre": ""
    }],
    "region": {
        "key": "US",
        "regionName": "United States"
    },
    "language": {
        "code": "en",
        "name": "English"
    },
    "brand_id": "67085422112246934",
    "duration": 1215,
    "duration_ms": 1215305,
    "ad_cue_points": [584234, 994334, 1173834],
    "source": "Hearst",
    "content_format": "Show",
    "content_type": "Episode",
    "series": {
        "series_id": "12341241",
        "series_title": "NH Chronicle",
        "series_description": "Series description",
        "season_number": 1,
        "season_title": "Season One",
        "season_description": "Season description",
        "episode_number": 1,
        "episode_title": "Baseball Card Collector",
        "season_description": "Season description"
    },
    "movie": {
        "movie_id": null,
        "movie_title": "",
        "movie_description": ""
    },
    "image_url": "https://images.frequency.com/video/10lnuqbezq0ue1k70/original/10lnuquk1c07i09e1k70.jpg",
    "media_type": "hls",
    "media_url": "https://media.frequency.com/videos/212541212123123/HK_JclkpQoiX.m3u8",
    "subtitles": [{
        "language": "en",
        "subtitle_": "https://subtitles.frequency.com/21254121923123/es/srt/162633312F65EF30AE8_Converted.srt",
        "type": "SRT"
    }],
    "last_updated": "2021-05-20T07:21:47Z",
    "date_expired": null,
    "date_publish": "2021-05-13T15:46:26Z",
    "date_created": "2021-05-13T15:46:26Z"
}

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-Device": "d9d7465c2341014f26a87629be46639e" "X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2" "Content-Type": "application/json"
Body Expand { "video_id": "6798629928574052699", "video_source_id": "content-partner-video-id-1234", "title": "NH Chronicle: Baseball Card Collector", "description": "The great ballplayers of the Negro Leagues", "keywords": "chronicle,baseball,collectibles", "parental_rating": "TV14", "age_rating": 14, "genres": [{ "genre": "News", "sub_genre": "" }], "region": { "key": "US", "regionName": "United States" }, "language": { "code": "en", "name": "English" }, "brand_id": "67085422112246934", "duration": 1215, "duration_ms": 1215305, "ad_cue_points": [584234, 994334, 1173834], "source": "Hearst", "content_format": "Show", "content_type": "Episode", "series": { "series_id": "12341241", "series_title": "NH Chronicle", "series_description": "Series description", "season_number": 1, "season_title": "Season One", "season_description": "Season description", "episode_number": 1, "episode_title": "Baseball Card Collector", "season_description": "Season description" }, "movie": { "movie_id": null, "movie_title": "", "movie_description": "" }, "image_url": "https://images.frequency.com/video/10lnuqbezq0ue1k70/original/10lnuquk1c07i09e1k70.jpg", "media_type": "hls", "media_url": "https://media.frequency.com/videos/212541212123123/HK_JclkpQoiX.m3u8", "subtitles": [{ "language": "en", "subtitle_": "https://subtitles.frequency.com/21254121923123/es/srt/162633312F65EF30AE8_Converted.srt", "type": "SRT" }], "last_updated": "2021-05-20T07:21:47Z", "date_expired": null, "date_publish": "2021-05-13T15:46:26Z", "date_created": "2021-05-13T15:46:26Z" }

Request

Headers

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

Response

Body

{
    "video_id": "6798629928574052699",
    "video_source_id": "content-partner-video-id-1234",
    "title": "NH Chronicle: Baseball Card Collector",
    "description": "The great ballplayers of the Negro Leagues",
    "keywords": "chronicle,baseball,collectibles",
    "parental_rating": "TV14",
    "age_rating": 14,
    "genres": [{
        "genre": "News",
        "sub_genre": ""
    }],
    "region": {
        "key": "US",
        "regionName": "United States"
    },
    "language": {
        "code": "en",
        "name": "English"
    },
    "brand_id": "67085422112246934",
    "duration": 1215,
    "duration_ms": 1215305,
    "ad_cue_points": [584234, 994334, 1173834],
    "source": "Hearst",
    "content_format": "Show",
    "content_type": "Episode",
    "series": {
        "series_id": "12341241",
        "series_title": "NH Chronicle",
        "series_description": "Series description",
        "season_number": 1,
        "season_title": "Season One",
        "season_description": "Season description",
        "episode_number": 1,
        "episode_title": "Baseball Card Collector",
        "season_description": "Season description"
    },
    "movie": {
        "movie_id": null,
        "movie_title": "",
        "movie_description": ""
    },
    "image_url": "https://images.frequency.com/video/10lnuqbezq0ue1k70/original/10lnuquk1c07i09e1k70.jpg",
    "media_type": "hls",
    "media_url": "https://media.frequency.com/videos/212541212123123/HK_JclkpQoiX.m3u8",
    "subtitles": [{
        "language": "en",
        "subtitle_": "https://subtitles.frequency.com/21254121923123/es/srt/162633312F65EF30AE8_Converted.srt",
        "type": "SRT"
    }],
    "last_updated": "2021-05-20T07:21:47Z",
    "date_expired": null,
    "date_publish": "2021-05-13T15:46:26Z",
    "date_created": "2021-05-13T15:46:26Z"
}

Search

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-Device": "d9d7465c2341014f26a87629be46639e" "X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2" "Content-Type": "application/json" Payload { "query": "\"baseball\"" }
Body Expand { "video_id": "6798629928574052699", "video_source_id": "content-partner-video-id-1234", "title": "NH Chronicle: Baseball Card Collector", "description": "The great ballplayers of the Negro Leagues", "keywords": "chronicle,baseball,collectibles", "parental_rating": "TV14", "age_rating": 14, "genres": [{ "genre": "News", "sub_genre": "" }], "region": { "key": "US", "regionName": "United States" }, "language": { "code": "en", "name": "English" }, "brand_id": "67085422112246934", "duration": 1215, "duration_ms": 1215305, "ad_cue_points": [584234, 994334, 1173834], "source": "Hearst", "content_format": "Show", "content_type": "Episode", "series": { "series_id": "12341241", "series_title": "NH Chronicle", "series_description": "Series description", "season_number": 1, "season_title": "Season One", "season_description": "Season description", "episode_number": 1, "episode_title": "Baseball Card Collector", "season_description": "Season description" }, "movie": { "movie_id": null, "movie_title": "", "movie_description": "" }, "image_url": "https://images.frequency.com/video/10lnuqbezq0ue1k70/original/10lnuquk1c07i09e1k70.jpg", "media_type": "hls", "media_url": "https://media.frequency.com/videos/212541212123123/HK_JclkpQoiX.m3u8", "subtitles": [{ "language": "en", "subtitle_": "https://subtitles.frequency.com/21254121923123/es/srt/162633312F65EF30AE8_Converted.srt", "type": "SRT" }], "last_updated": "2021-05-20T07:21:47Z", "date_expired": null, "date_publish": "2021-05-13T15:46:26Z", "date_created": "2021-05-13T15:46:26Z" }

Request

Headers

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

Payload

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

Response

Body

{
    "video_id": "6798629928574052699",
    "video_source_id": "content-partner-video-id-1234",
    "title": "NH Chronicle: Baseball Card Collector",
    "description": "The great ballplayers of the Negro Leagues",
    "keywords": "chronicle,baseball,collectibles",
    "parental_rating": "TV14",
    "age_rating": 14,
    "genres": [{
        "genre": "News",
        "sub_genre": ""
    }],
    "region": {
        "key": "US",
        "regionName": "United States"
    },
    "language": {
        "code": "en",
        "name": "English"
    },
    "brand_id": "67085422112246934",
    "duration": 1215,
    "duration_ms": 1215305,
    "ad_cue_points": [584234, 994334, 1173834],
    "source": "Hearst",
    "content_format": "Show",
    "content_type": "Episode",
    "series": {
        "series_id": "12341241",
        "series_title": "NH Chronicle",
        "series_description": "Series description",
        "season_number": 1,
        "season_title": "Season One",
        "season_description": "Season description",
        "episode_number": 1,
        "episode_title": "Baseball Card Collector",
        "season_description": "Season description"
    },
    "movie": {
        "movie_id": null,
        "movie_title": "",
        "movie_description": ""
    },
    "image_url": "https://images.frequency.com/video/10lnuqbezq0ue1k70/original/10lnuquk1c07i09e1k70.jpg",
    "media_type": "hls",
    "media_url": "https://media.frequency.com/videos/212541212123123/HK_JclkpQoiX.m3u8",
    "subtitles": [{
        "language": "en",
        "subtitle_": "https://subtitles.frequency.com/21254121923123/es/srt/162633312F65EF30AE8_Converted.srt",
        "type": "SRT"
    }],
    "last_updated": "2021-05-20T07:21:47Z",
    "date_expired": null,
    "date_publish": "2021-05-13T15:46:26Z",
    "date_created": "2021-05-13T15:46:26Z"
}

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-Device": "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" } }
Body Expand { "videos": [{ "video_id": "6798629928574052699", "video_source_id": "content-partner-video-id-1234", "title": "NH Chronicle: Baseball Card Collector", "description": "The great ballplayers of the Negro Leagues", "keywords": "chronicle,baseball,collectibles", "parental_rating": "TV14", "age_rating": 14, "genres": [{ "genre": "News", "sub_genre": "" }], "region": { "key": "US", "regionName": "United States" }, "language": { "code": "en", "name": "English" }, "brand_id": "67085422112246934", "duration": 1215, "duration_ms": 1215305, "ad_cue_points": [584234, 994334, 1173834], "source": "Hearst", "content_format": "Show", "content_type": "Episode", "series": { "series_id": "12341241", "series_title": "NH Chronicle", "series_description": "Series description", "season_number": 1, "season_title": "Season One", "season_description": "Series description", "episode_number": 1, "episode_title": "Baseball Card Collector", "episode_description": "Series description" }, "movie": { "movie_id": null, "movie_title": "", "movie_description": "" }, "image_url": "https://images.frequency.com/video/10lnuqbezq0ue1k70/original/10lnuquk1c07i09e1k70.jpg", "media_type": "hls", "media_url": "https://media.frequency.com/videos/212541212123123/HK_JclkpQoiX.m3u8", "subtitles": [{ "language": "en", "subtitle_": "https://subtitles.frequency.com/21254121923123/es/srt/162633312F65EF30AE8_Converted.srt", "type": "SRT" }], "last_updated": "2021-05-20T07:21:47Z", "date_expired": null, "date_publish": "2021-05-13T15:46:26Z", "date_created": "2021-05-13T15:46:26Z" }], "page": { "page_size": 30, "page_offset": "6798629928574052699", "page_mark": "6798629928574052699" } }

Request

Headers

"X-Frequency-Device": "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

{
    "videos": [{
        "video_id": "6798629928574052699",
        "video_source_id": "content-partner-video-id-1234",
        "title": "NH Chronicle: Baseball Card Collector",
        "description": "The great ballplayers of the Negro Leagues",
        "keywords": "chronicle,baseball,collectibles",
        "parental_rating": "TV14",
        "age_rating": 14,
        "genres": [{
            "genre": "News",
            "sub_genre": ""
        }],
        "region": {
            "key": "US",
            "regionName": "United States"
        },
        "language": {
            "code": "en",
            "name": "English"
        },
        "brand_id": "67085422112246934",
        "duration": 1215,
        "duration_ms": 1215305,
        "ad_cue_points": [584234, 994334, 1173834],
        "source": "Hearst",
        "content_format": "Show",
        "content_type": "Episode",
        "series": {
            "series_id": "12341241",
            "series_title": "NH Chronicle",
            "series_description": "Series description",
            "season_number": 1,
            "season_title": "Season One",
            "season_description": "Series description",
            "episode_number": 1,
            "episode_title": "Baseball Card Collector",
            "episode_description": "Series description"
        },
        "movie": {
            "movie_id": null,
            "movie_title": "",
            "movie_description": ""
        },
        "image_url": "https://images.frequency.com/video/10lnuqbezq0ue1k70/original/10lnuquk1c07i09e1k70.jpg",
        "media_type": "hls",
        "media_url": "https://media.frequency.com/videos/212541212123123/HK_JclkpQoiX.m3u8",
        "subtitles": [{
            "language": "en",
            "subtitle_": "https://subtitles.frequency.com/21254121923123/es/srt/162633312F65EF30AE8_Converted.srt",
            "type": "SRT"
        }],
        "last_updated": "2021-05-20T07:21:47Z",
        "date_expired": null,
        "date_publish": "2021-05-13T15:46:26Z",
        "date_created": "2021-05-13T15:46:26Z"
    }],
    "page": {
        "page_size": 30,
        "page_offset": "6798629928574052699",
        "page_mark": "6798629928574052699"
    }
}

Playlists

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

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-Device": "d9d7465c2341014f26a87629be46639e" "X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2" "Content-Type": "application/json"
Body Expand { "playlists": [{ "playlist_id": "56bef52-72114c75-b170-dc555127896", "title": "NH Playlist", "description": "Playlist for NH", "language": "", "region": { "key": "US", "regionName": "United States" }, "parental_rating": "TVPG", "genres": [{ "genre": "News", "sub_genre": "" }], "status": "ENABLED", "image_url": "https://images.frequency.com/playlist/id123121212/solid_rectangle.jpg", "asset_type": "VIDEO", "create_date": "2020-06-10T20:38:16.000+0000", "last_updated": "2020-06-10T20:58:19.000+0000", "video_count": 10, "solid_square": "https://images.frequency.com/playlist/id123121212/solid_square.jpg", "solid_rectangle": "https://images.frequency.com/playlist/id123121212/solid_rectangle.jpg", "dark_transparent_square": null, "dark_transparent_rectangle": null, "light_transparent_square": null, "light_transparent_rectangle": null }], "page": { "page_size": 30, "page_offset": "6798629928574052699", "page_mark": "6798629928574052699" } }

Request

Headers

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

Response

Body

{
    "playlists": [{
        "playlist_id": "56bef52-72114c75-b170-dc555127896",
        "title": "NH Playlist",
        "description": "Playlist for NH",
        "language": "",
        "region": {
            "key": "US",
            "regionName": "United States"
        },
        "parental_rating": "TVPG",
        "genres": [{
            "genre": "News",
            "sub_genre": ""
        }],
        "status": "ENABLED",
        "image_url": "https://images.frequency.com/playlist/id123121212/solid_rectangle.jpg",
        "asset_type": "VIDEO",
        "create_date": "2020-06-10T20:38:16.000+0000",
        "last_updated": "2020-06-10T20:58:19.000+0000",
        "video_count": 10,
        "solid_square": "https://images.frequency.com/playlist/id123121212/solid_square.jpg",
        "solid_rectangle": "https://images.frequency.com/playlist/id123121212/solid_rectangle.jpg",
        "dark_transparent_square": null,
        "dark_transparent_rectangle": null,
        "light_transparent_square": null,
        "light_transparent_rectangle": null
    }],
    "page": {
        "page_size": 30,
        "page_offset": "6798629928574052699",
        "page_mark": "6798629928574052699"
    }
}

Retrieve specific playlist metadata

GET /playlists/<playlist_id>

Request
Headers "X-Frequency-Device": "d9d7465c2341014f26a87629be46639e" "X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2" "Content-Type": "application/json"
Body Expand { "playlist_id": "56bef52-72114c75-b170-dc555127896", "title": "NH Playlist", "description": "Playlist for NH", "language": "", "region": { "key": "US", "regionName": "United States" }, "parental_rating": "TVPG", "genres": [{ "genre": "News", "sub_genre": "" }], "status": "ENABLED", "image_url": "https://images.frequency.com/playlist/id123121212/solid_rectangle.jpg", "asset_type": "VIDEO", "create_date": "2020-06-10T20:38:16.000+0000", "last_updated": "2020-06-10T20:58:19.000+0000", "video_count": 10, "solid_square": "https://images.frequency.com/playlist/id123121212/solid_square.jpg", "solid_rectangle": "https://images.frequency.com/playlist/id123121212/solid_rectangle.jpg", "dark_transparent_square": null, "dark_transparent_rectangle": null, "light_transparent_square": null, "light_transparent_rectangle": null }

Request

Headers

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

Response

Body

{
    "playlist_id": "56bef52-72114c75-b170-dc555127896",
    "title": "NH Playlist",
    "description": "Playlist for NH",
    "language": "",
    "region": {
        "key": "US",
        "regionName": "United States"
    },
    "parental_rating": "TVPG",
    "genres": [{
        "genre": "News",
        "sub_genre": ""
    }],
    "status": "ENABLED",
    "image_url": "https://images.frequency.com/playlist/id123121212/solid_rectangle.jpg",
    "asset_type": "VIDEO",
    "create_date": "2020-06-10T20:38:16.000+0000",
    "last_updated": "2020-06-10T20:58:19.000+0000",
    "video_count": 10,
    "solid_square": "https://images.frequency.com/playlist/id123121212/solid_square.jpg",
    "solid_rectangle": "https://images.frequency.com/playlist/id123121212/solid_rectangle.jpg",
    "dark_transparent_square": null,
    "dark_transparent_rectangle": null,
    "light_transparent_square": null,
    "light_transparent_rectangle": null
}

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

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-Device": "d9d7465c2341014f26a87629be46639e" "X-Frequency-Auth": "dd61135eba-2c1cc8e4-37cc5e-3d54e0c2" "Content-Type": "application/json"
Body Expand { "playlist": { "playlist_id": "56bef52-72114c75-b170-dc555127896", "title": "NH Playlist", "description": "Playlist for NH", "language": "", "region": { "key": "US", "regionName": "United States" }, "parental_rating": "TVPG", "genres": [{ "genre": "News", "sub_genre": "" }], "status": "ENABLED", "image_url": "https://images.frequency.com/playlist/id123121212/solid_rectangle.jpg", "asset_type": "VIDEO", "create_date": "2020-06-10T20:38:16.000+0000", "last_updated": "2020-06-10T20:58:19.000+0000", "video_count": 10, "solid_square": "https://images.frequency.com/playlist/id123121212/solid_square.jpg", "solid_rectangle": "https://images.frequency.com/playlist/id123121212/solid_rectangle.jpg", "dark_transparent_square": null, "dark_transparent_rectangle": null, "light_transparent_square": null, "light_transparent_rectangle": null }, "videos": [{ "video_id": "6798629928574052699", "video_source_id": "content-partner-video-id-1234", "title": "NH Chronicle: Baseball Card Collector", "description": "The great ballplayers of the Negro Leagues", "keywords": "chronicle,baseball,collectibles", "parental_rating": "TV14", "age_rating": 14, "genres": [{ "genre": "News", "sub_genre": "" }], "region": { "key": "US", "regionName": "United States" }, "language": { "code": "en", "name": "English" }, "brand_id": "67085422112246934", "duration": 1215, "duration_ms": 1215305, "ad_cue_points": [584234, 994334, 1173834], "source": "Hearst", "content_format": "Show", "content_type": "Episode", "series": { "series_id": "12341241", "series_title": "NH Chronicle", "series_description": "Series description", "season_number": 1, "season_title": "Season One", "season_description": "Series description", "episode_number": 1, "episode_title": "Baseball Card Collector", "episode_description": "Series description" }, "movie": { "movie_id": null, "movie_title": "", "movie_description": "" }, "image_url": "https://images.frequency.com/video/10lnuqbezq0ue1k70/original/10lnuquk1c07i09e1k70.jpg", "media_type": "hls", "media_url": "https://media.frequency.com/videos/212541212123123/HK_JclkpQoiX.m3u8", "subtitles": [{ "language": "en", "subtitle_": "https://subtitles.frequency.com/21254121923123/es/srt/162633312F65EF30AE8_Converted.srt", "type": "SRT" }], "last_updated": "2021-05-20T07:21:47Z", "date_expired": null, "date_publish": "2021-05-13T15:46:26Z", "date_created": "2021-05-13T15:46:26Z" }], "page": { "page_size": 30, "page_offset": "6798629928574052699", "page_mark": "6798629928574052699" } }

Request

Headers

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

Response

Body

{
    "playlist": {
        "playlist_id": "56bef52-72114c75-b170-dc555127896",
        "title": "NH Playlist",
        "description": "Playlist for NH",
        "language": "",
        "region": {
            "key": "US",
            "regionName": "United States"
        },
        "parental_rating": "TVPG",
        "genres": [{
            "genre": "News",
            "sub_genre": ""
        }],
        "status": "ENABLED",
        "image_url": "https://images.frequency.com/playlist/id123121212/solid_rectangle.jpg",
        "asset_type": "VIDEO",
        "create_date": "2020-06-10T20:38:16.000+0000",
        "last_updated": "2020-06-10T20:58:19.000+0000",
        "video_count": 10,
        "solid_square": "https://images.frequency.com/playlist/id123121212/solid_square.jpg",
        "solid_rectangle": "https://images.frequency.com/playlist/id123121212/solid_rectangle.jpg",
        "dark_transparent_square": null,
        "dark_transparent_rectangle": null,
        "light_transparent_square": null,
        "light_transparent_rectangle": null
    },
    "videos": [{
        "video_id": "6798629928574052699",
        "video_source_id": "content-partner-video-id-1234",
        "title": "NH Chronicle: Baseball Card Collector",
        "description": "The great ballplayers of the Negro Leagues",
        "keywords": "chronicle,baseball,collectibles",
        "parental_rating": "TV14",
        "age_rating": 14,
        "genres": [{
            "genre": "News",
            "sub_genre": ""
        }],
        "region": {
            "key": "US",
            "regionName": "United States"
        },
        "language": {
            "code": "en",
            "name": "English"
        },
        "brand_id": "67085422112246934",
        "duration": 1215,
        "duration_ms": 1215305,
        "ad_cue_points": [584234, 994334, 1173834],
        "source": "Hearst",
        "content_format": "Show",
        "content_type": "Episode",
        "series": {
            "series_id": "12341241",
            "series_title": "NH Chronicle",
            "series_description": "Series description",
            "season_number": 1,
            "season_title": "Season One",
            "season_description": "Series description",
            "episode_number": 1,
            "episode_title": "Baseball Card Collector",
            "episode_description": "Series description"
        },
        "movie": {
            "movie_id": null,
            "movie_title": "",
            "movie_description": ""
        },
        "image_url": "https://images.frequency.com/video/10lnuqbezq0ue1k70/original/10lnuquk1c07i09e1k70.jpg",
        "media_type": "hls",
        "media_url": "https://media.frequency.com/videos/212541212123123/HK_JclkpQoiX.m3u8",
        "subtitles": [{
            "language": "en",
            "subtitle_": "https://subtitles.frequency.com/21254121923123/es/srt/162633312F65EF30AE8_Converted.srt",
            "type": "SRT"
        }],
        "last_updated": "2021-05-20T07:21:47Z",
        "date_expired": null,
        "date_publish": "2021-05-13T15:46:26Z",
        "date_created": "2021-05-13T15:46:26Z"
    }],
    "page": {
        "page_size": 30,
        "page_offset": "6798629928574052699",
        "page_mark": "6798629928574052699"
    }
}

Unified Scheduling

Ingest videos and schedule in channel

POST /automation/schedule

Request
Headers "X-Frequency-Device": "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 } }
Body { "request_id": "1", "message": "Schedule Added for processing" }

Request

Headers

"X-Frequency-Device": "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

Field

Description

Values

Required

Reference

videos.video_url

Video asset (720p+ 16:9)

Publicly accessible http or https URL

Yes

https://my.host.com/folder/videos/12345/latest.mp4

videos.video_source_id

External unique identifier

Text

Yes

Your internal unique video identifier

videos.type

Type of video

TIME_STRETCH
INTERSTITIAL
AD_POD
VIDEO

Yes

videos.title

Title of the video

Text

Yes

videos.periodicity

Periodicity

One-Time
Weekly
Monthly
Seasonal

Request
Expand curl 'https://api-cms.frequency.com/api/1.0/cms/periodicity' -H 'X-Frequency-Auth: {your-auth-token}' -H 'X-Frequency-DeviceId: {your-device-id}' -H 'Content-Type: application/json'

videos.parental_rating

Parental rating

Yes

Request
Expand curl 'https://api-cms.frequency.com/api/1.0/cms/parental_rating' -H 'X-Frequency-Auth: {your-auth-token}' -H 'X-Frequency-DeviceId: {your-device-id}' -H 'Content-Type: application/json'

videos.image_url

Image thumbnail (720p+ 16:9)

Publicly accessible http or https URL

Yes

https://my.host.com/folder/images/12345/thumbnail.jpg

videos.duration

Total run time duration for video

Milliseconds integer

Yes

videos.description

Description of the video

Text

Yes

videos.genres

Genre/Sub-genres

JSON array of genres/sub-genres

Yes

Request

videos.cut

Cut

Request
Expand curl 'https://api-cms.frequency.com/api/1.0/cms/cut' -H 'X-Frequency-Auth: {your-auth-token}' -H 'X-Frequency-DeviceId: {your-device-id}' -H 'Content-Type: application/json'

videos.audio_language

Audio language

ISO 639-1 2-letter language code such as "en"

Yes

https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

Request
Expand curl 'https://api-cms.frequency.com/api/1.0/cms/languages' -H 'X-Frequency-Auth: {your-auth-token}' -H 'X-Frequency-DeviceId: {your-device-id}' -H 'Content-Type: application/json'

videos.country_origin

Country of Origin

ISO 3166 Alpha 2 country code such as "US"

Yes

https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes

Request
Expand curl 'https://api-cms.frequency.com/api/1.0/cms/region' -H 'X-Frequency-Auth: {your-auth-token}' -H 'X-Frequency-DeviceId: {your-device-id}' -H 'Content-Type: application/json'

videos.content_type

Content Type

Request
Expand curl 'https://api-cms.frequency.com/api/1.0/cms/region' -H 'X-Frequency-Auth: {your-auth-token}' -H 'X-Frequency-DeviceId: {your-device-id}' -H 'Content-Type: application/json'

videos.content_format

Content Format

Show
Movie
Event

Yes

Request
Expand curl 'https://api-cms.frequency.com/api/1.0/cms/content_format' -H 'X-Frequency-Auth: {your-auth-token}' -H 'X-Frequency-DeviceId: {your-device-id}' -H 'Content-Type: application/json'

source_id

Frequency internal identifier

Text

Yes

Provided by Frequency

schedule.start_time

Time the linear program should begin for channel

UTC date-time

(yyyy-mm-dd hh:mm:ss.sssz)

Yes

schedule.duration_ms

Duration of the linear program (should match sum of durations, but may be longer as a Time Fill component will be automatically added)

Milliseconds integer

Yes

Total content duration cannot exceed scheduled linear program duration

program_title

Title of linear program

Text

Yes

program_description

Description of linear program

Text

linear_channel_id

Linear Channel

Text

Yes

Provided by Frequency or retrieved via upstream API

brand_id

Brand to ingest new videos

Text

Yes

Provided by Frequency

Troubleshooting

Issue	API
Video Ingestion problems found in details	Expand GET https://prd-freq.frequency.com/api/2.0/cms/ingestion_video/{ingestion_video_id}
Response	Body { "ingestion_video_id": "1", "video_source_id": "123456", "linear_channel_id": "21", "source_id": "6291431901791729322", "brand_id": "6429846635265866447", "video_frequency_id": null, "status": "ERROR", "error": "Content-Format is Invalid", "data": { "title": "Video1 Title", "description": "Video1 Description", "image_url": "https://my.server.com/content/video1-thumbnail.jpg", "video_url": "https://my.server.com/content/video1.mp4", "video_duration_ms": 20000, "genres": [ { "genre": "Travel", "sub_genre": "Africa" }, { "genre": "Travel", "sub_genre": "Outdoors" } ], "audio_language": "en", "country_origin": "US", "content_format": "XYZ", "content_type": "Recipes", "cut": "Clip", "periodicity": "Daily", "parental_rating": "Child" } }
Resolution	API
In the case above, invalid metadata for a video was submitted. This can be resolved by using the following PUT request to correct the original metadata:	Expand PUT https://prd-freq.frequency.com/api/2.0/cms/ingestion_video/{ingestion_video_id} Payload { "title": "Video1 Title", "description": "Video1 Description", "image_url": "https://my.server.com/content/video1-thumbnail.jpg", "video_url": "https://my.server.com/content/video1.mp4", "video_duration_ms": 20000, "genres": [ { "genre": "Travel", "sub_genre": "Africa" }, { "genre": "Travel", "sub_genre": "Outdoors" } ], "audio_language": "en", "country_origin": "US", "content_format": "Movies", "content_type": "Recipes", "cut": "Clip", "periodicity": "Daily", "parental_rating": "Child" }

In this section:

Frequency Documentation

Endpoints

Metadata

Videos

Search

Playlists

Unified Scheduling

Search results