Frequency Documentation

Scheduling Outputs (EPG)

Electronic Program Guide (EPG) information per channel can be queried using a public API to retrieve data. The scheduling data is real-time with a cache for high scalability and performance load times.

  • Linear Channel (ID)

  • Timeframe (Date start/end)

  • Days (Number of days to return)

  • Format (Roku On Now, XMLTV, Xperi, Rovi TVXML, Roku True EPG, Brightcove Beacon, Google DFP, XML, CSV)

  • Type (Summary vs. Detailed)

Linear Schedule URL

JSON: https://static.frequency.com/studio/epg/{id}.json

Additional Formats: https://script.google.com/macros/s/AKfycbwVvwv0P5RdPH7z4siy0I9fBc71MOHRMFv7JUsBlVADYP2T53E/exec?id={id}&format={format}&type={type}&date={date}&days={days}&title={null|video}

where:

  • id is the channel id

    • Channel id is the unique identifier for the linear channel at Frequency

  • format is the output format (csv, xml, xmltv, tvxml, roku_true_epg, roku_on_now, brightcove, dfp)

    • xml: Standardized

    • csv: Standardized (schedule data only)

    • xmltv: Standardized XMLTV format

    • xmltv_range: Standardized XMLTV format variant that returns scheduling for the date range to today -1 and +7 days

    • tvxml: Custom for Rovi, Comcast, Sinclair

    • Xperi: Rovi-based XML for SlingTV

    • roku_true_epg|roku_on_now|roku: Custom for Roku. Returns scheduling for the date range to today -1 and +7 days

    • brightcove: Custom for Roku

    • dfp: Metadata export for Google DFP content-level ad decisioning

  • type is for the results type (summary, detailed) where detailed (extended video information)

    • summary: Available for xml, and csv. Returns 7 days of scheduling at once

    • detailed: Available for xmltv, tvxml, roku_true_epg, roku_on_now, roku, and brightcove. Type is set to detailed by default.

      • For roku_true_epg, it returns yesterday and the next 7 days of scheduling by default.

  • date for a different date

    • yyyy-mm-dd: Date format is optional. If not provided, today's date will be used for start date of the query.

  • days is for how many days of results to return (only applicable when type=detailed); must be a positive integer

    • Required only when type=detailed

Output Formats

  • json: Standardized

  • xml: Standardized (schedule data only)

  • csv: Standardized (schedule data only)

  • xmltv: Standardized EPG format

  • xmltv_series: Puts series name in title, and episode names in sub-title

  • tvxml: Custom for Rovi-compatible systems

  • xperi: Custom for Rovi-based systems

  • roku_true_epg: Custom for Roku (latest generation)

  • roku_on_now: Custom for Roku (simplified)

  • brightcove: Custom for Brightcove Beacon

  • dfp: Google DFP content-level ad targeting

Metadata Fields

Metadata

Summary

Detailed

output: Information about the scheduling output request.

Not applicable

  • type: "Summary" or "Detailed"

  • format: "XML", "TVXML", or "CSV"

  • timeframe: The timeframe of the returned scheduled programming. By default, "1 day" is returned if none is supplied during the request

  • start: Start date/time of scheduled programming in UTC time for the request

  • end: End date/time of scheduled programming in UTC time for the request, calculated from the number of days requested and relative to the start date-time.

  • query: Execution timestamp of the query if not cached. Queries of the same parameters are cached for up 30 minutes for certain channels

  • queryDuration: The query execution duration

  • responseCharacters: Internal use

  • scheduleItems: Number of scheduled programming items for the request

channel: Information about the linear channel

Not applicable

  • id: Internal unique identifier for linear channel

  • status: "On Air", "Pending On Air", "Offline". Status of linear channel. "On Air" status is when video is playing and is the expected value for all production channels

  • name: Name of the linear channel

  • description: Description of the linear channel

  • thumbnail: Artwork hosted URL for the linear channel (JPG or PNG)

  • genre: Frequency genre for the linear channel

  • subGenre: Frequency sub-genre for the linear channel

  • timezoneName: Reference timezone for the linear channel. This is used for programming content in the Scheduling tools. Scheduled programming in the EPG output is in UTC time.

  • countryName: The country of origin for the linear channel

  • parentalRating: Parental rating value of linear channel. The value depends on the country of origin. In the U.S., it can be TV Ratings or MPAA.

  • language: The primary language of the programming of the linear channel

  • resolution: The maximum resolution of the linear channel video stream in the format of width x height pixels "1280x720"

  • width: Resolution width pixels

  • height: Resolution height pixels

schedule: Information about the timed programming for the channel.

  • start_time: Start timestamp in UTC of the scheduled programming

  • end_time: End timestamp in UTC of the scheduled programming

  • duration: Duration of the scheduled programming in seconds

  • type_of_program: "VOD_PROGRAM" for individual content programming or "PLAYLIST_PROGRAM" for programming block constructed from a set of short-form content

  • title: Title of the content

  • vod_program_status: Status of the programmed content. Values can be "Ready for Air" or "Draft"

  • start: Start timestamp in UTC of the scheduled programming

  • end: End timestamp in UTC of the scheduled programming

  • duration: Duration of the scheduled programming in seconds

  • programType: "VOD_PROGRAM" for individual content programming or "PLAYLIST_PROGRAM" for programming block constructed from a set of short-form content

  • videoId: Internal unique identifier for the content

  • videoIdPartner: Content partner's unique identifier for the content

  • thumbnail: Thumbnail URL for the content (JPG or PNG)

  • title: Title of the content

  • titleInternal: Internal title of the content

  • description: Description of the content

  • keywords: Keywords for the content

  • ratingAge: Frequency normalized age rating across rating agencies and countries (Values can be 1-18 "Suitable for ages 1+, 2+, 3+,...18+" and 99 "Unrated")

  • parentalRating: Rating value ("TV-G", "PG-13", "NR", "UR", etc.)

  • country: Country code (ISO-3166-1 Alpha 2) for the content

  • countryName: Name of country of origin for the content

  • languageName: Primary language of the content

  • contentType: Type of content ("Interview", "Compilation", etc.)

  • contentFormat: Format of content - "Movie" (film), Show" (episodic), "Event" (one-time)

  • genre: Frequency genre/sub-genre for content. The full list of genre/sub-genre is available upon request

  • series: Series name if episodic, when available

  • season: Season number if episodic, when available

  • episode: Episode number if episodic when available

  • adBreakPositions: Comma-separated cue points for ad breaks in seconds with milliseconds accuracy ("754.112,1520.1441,...")

  • externalMetadataId: External metadata vendor ID, when available ("MV10299338122")