Nielsen Local Monthlies API Release 1.0 Documentation Endpoint Details: https://api.developer.nielsen.com/watchapi/local/monthlies/api/v1 Rate limit: 3 calls per second Authentication Instructions: To generate an access token, please see the OAuth 2.0 Guide on how to use the Authorization API. To make an API call, pass in the below header with your access token: Key: Authorization Value: Bearer 762CoxehAgJsCmRCTA6CIqUnQzwYOH20n9NMiJc6rm9xKrVMYH2oZD Note: There is a space and an access token after bearer. The access token must be generated using the authorization endpoint. Example request in Postman:
dataavailabilities Description: Determine what data is available in the API (Data streams, measurement periods, sample types, etc.) Request URL: https://api.developer.nielsen.com/watchapi/local/monthlies/api/v1/dataavailabilities? Parameter Name Parameter Description Type marketid Int Unique DMA identifier (e.g."501" for New York) marketname String Nielsen DMA name (e.g. "New York, NY") markettype String The collection method of the DMA (e.g. "LPM", "Set-Meter", Code Reader, Diary ) year Int The year corresponding to the measurement period (e.g. 2015 ) month String The month corresponding to the measurement period (e.g. March ) datasource String Data sample (e.g. Cable, Hispanic, Black, Household ) excludeunsubscribedmarkets Bool True by default. When true, the response will be limited to only markets that the user is subscribed to. If false, the response will return metadata for all markets. Response Field marketid marketname Description Unique DMA identifier (e.g."501" for New York) Nielsen DMA name (e.g. New York, NY ) markettype The collection method of the DMA (e.g. LPM, Set-Meter ) year The year corresponding to the measurement period (e.g. 2015 ) month datasource The month corresponding to the measurement period (e.g. March ) Data sample (e.g. Cable, Hispanic, Black, Household ) surveystartdate First broadcast date of the survey period (YYYY-MM-DD) surveyenddate Last broadcast date of the survey period (YYYY-MM-DD)
markets Description: Market or Designated Market Area (DMA) metadata. Request URL: https://api.developer.nielsen.com/watchapi/local/monthlies/api/v1/markets? Example URL: https://api.developer.nielsen.com/watchapi/local/monthlies/api/v1/markets?markettype=diary Parameter Name Parameter Description Type marketid int Unique DMA identifier (e.g."501" for New York) marketname String Nielsen DMA name (e.g. "New York, NY") markettype String The collection method of the DMA (e.g. "LPM", "Set-Meter") marketrank int The current rank of the DMA (e.g. "1" corresponds to the most populated DMA, New York) excludeunsubscribedmarkets Bool True by default. When true, the response will be limited to only markets that the user is subscribed to. If false, the response will return metadata for all markets. Response Field marketid marketname markettype marketabbr marketrank Description Unique DMA identifier (e.g."501"for New York) Nielsen DMA name (e.g. "New York, NY") The collection method of the DMA ( LPM, Set-Meter, Code Reader, Diary ) Abbreviated DMA name (e.g. "NY") The current rank of the DMA (e.g. "1" corresponds to the most populated DMA, New York)
stations Description: Station metadata for markets where there has been viewing of the station. Includes cume data for a specified measurement period for the 7am-1am daypart. Request URL: https://api.developer.nielsen.com/watchapi/local/monthlies/api/v1/stations? Example Request: https://api.developer.nielsen.com/watchapi/local/monthlies/api/v1/stations?excludespill=false&market Id=501 Parameter Name Parameter Description Type stationid int Unique station identifier. (e.g. 5010) stationname String Station name/call Letters (e.g. WABC-TV 7.2 ) affiliation String Network affiliation of local broadcast station (e.g. ABC ) callletters string Call letters for the station (e.g. WABC) distributiontype String Distributor station type (e.g. Broadcast or Cable ) cumethreshold Float Corresponds to stationcume filters out all stations with stationcume below the input value. If null, then the threshold will be 2.5 cumeperiod Date If not specified, most recent cume period for each station is returned. If specified (e.g. YYYY- MM-DD; 2015-10-28), stationcume data for the measurement period that the date falls in to is returned (or null if there was no cume for the station during that measurement period) excludespill Bool Defaults to false. Controls whether or not to return broadcast stations originating in different markets (e.g. true, false ) originmarketid int Market ID of the DMA where the source originated from originmarketname String Name of station s origin market (e.g. New York ) marketid Int Market ID of the DMA (e.g. 501 for NY). Market IDs can be retrieved from the data availability or markets reference call) marketname String Nielsen DMA name (e.g. New York, NY ) parentplusindicator String Indicates whether a station is a part of a Parent+ relationship. Options are Parent+ (denoting the sum of parent station with satellites), Parent, Satellite, or Other (returns only stations which are not a part of a parent+ relationship).
excludeunsubscribedmarkets Bool True by default. When true, the response will be limited to only markets that the user is subscribed to. If false, the response will return metadata for all markets. Response Field stationid stationname callletters affiliation airchannel parentplusindicator distributiontype stationcume cumeperiod originmarketid originmarketname marketid marketname Description Unique numerical Station Identifier Station name Call letters for the station (e.g. WABC) Network affiliation of local broadcast station Station air channel Denotes whether a station is part of a parent+ relationship. (e.g. Parent+, Parent, Satellite, null) Distributor station type ( Broadcast or Cable ) Cume for the measurement period. If cumeperiod is not specified, it should be the most recent cume. If no threshold is set and there is no cume for a station, then a null should be returned Measurement period for the stationcume returned Market ID of the DMA where the source originated from DMA name where the source originated from Market ID of the DMA (e.g. 501 for NY) Nielsen DMA name
programs Description: Program lineup metadata for a specified broadcast day, market, and station. Request URL: https://api.developer.nielsen.com/watchapi/local/monthlies/api/v1/programs? Example URL: https://api.developer.nielsen.com/watchapi/local/monthlies/api/v1/programs?broadcastdate=2016-04- 29&reportStart=03%3A00&reportEnd=03%3A00&marketId=501&stationId=5010 Parameter Name Parameter Description Type broadcastdate (required) Date Broadcast day of requested data in the following format: YYYY-MM-DD (e.g. 2015-12-10 ) reportstart String Report start time (e.g. HH:MM; 12:20 24-hour time). Optional field defaults to a full broadcast day, 03:00AM 03:00AM. reportend string Report end time (e.g. HH:MM; 13:20 24-hour time). Optional field defaults to a full broadcast day, 03:00AM 03:00AM. programid Int Unique numeric Program Identifier programname String Program name. This parameter can be used as a filter and searches for the closest match (e.g. Wheel ) programsource String Network source for the program (e.g. FOX ) stationid (required) Int Numerical ID code of the station (e.g. 5015 for WABC-TV 7.1 in the NY DMA). Station ID can be retrieved from the stations reference call originmarketid Int Market ID of the DMA where the source originated from marketid (required) Int (e.g. 501 ) Market ID of the DMA (e.g. 501 for NY). Market IDs can be retrieved from the data availability or markets reference call) telecastid int Unique numeric Identifier for each Telecast trackageid Int Trackage ID to provide a way of identifying which airing of the specific telecast trackagename String Client provided name to track each telecast Response Field broadcastdate broadcastdayofweekname programid programname telecaststarttime telecastendtime totalduration Description The date on which the program originally aired (YYYY-MM- DD). The broadcast day of the week during which the program aired (e.g. THURSDAY ). Unique numeric Program Identifier Program Name Local time for when the program starts Local time for when the program ends Total duration of the program
telecastactualstarttime telecastactualendtime programtypecode programtypedesc programsource stationid stationname callletters affiliation distributiontype episodeid episodetitle telecastid trackageid trackagename originmarketid originmarketname marketid marketname Actual start time of telecast (not quarter-hour bound) Actual end time of telecast (not quarter-hour bound) Broadcast special code to denote the type of program Describes what type of program it is Network source for the program Numerical ID code of the station (e.g. 5015 for WABC-TV 7.1 in the NY DMA). Station ID can be retrieved from the stations reference call Station name Call letters for the station (e.g. WABC) Network affiliation of local broadcast station Distributor station type ( Broadcast or Cable ) Unique ID number for an episode Name of the episode Unique numeric Identifier for each Telecast Trackage ID to provide a way of identifying which airing of the specific telecast Client provided name to track each telecast Market ID of the DMA where the source originated from DMA name where the source originated from Market ID of the DMA (e.g. 501 for NY) Nielsen DMA name
quarterhourratings Description: Quarter-hour ratings metrics for a specified broadcast day, market, station, data stream, sample type, and demographic. Request URL: https://api.developer.nielsen.com/watchapi/local/monthlies/api/v1/quarterhourratings? Example URL: https://api.developer.nielsen.com/watchapi/local/monthlies/api/v1/quarterhourratings?broadcastdate =2015-11- 28&reportStart=03%3A00&reportEnd=03%3A00&gender=Person&marketId=501&stationId=5015&data Source=Household&dataStream=Live%2BSD&feedPatternCode=None Parameter Name Parameter Description Type broadcastdate (required) Date Broadcast day of requested data in the following format: YYYY-MM-DD (e.g. 2015-12-10 ) reportstart string Report start time (e.g. HH:MM; 12:20 24- hour time). Optional field defaults to a full broadcast day, 03:00AM 03:00AM. reportend string Report end time (e.g. HH:MM; 13:20 24- hour time). Optional field defaults to a full broadcast day, 03:00AM 03:00AM. gender (required) string Gender of the target demographic. Households Person Male Female startage Int Youngest age of the target demographic (e.g. If target demographic is Persons 18-34, startage will be 18). 2 (default if no startage is specified, Available for persons only) 6 (Available for persons only) 12 15 18 21 25 35 50 55 65
endage Int Oldest age of the target demographic (e.g. If the target demographic is Persons 18-34, endage will be 34). 5 (Persons Only) 11 (Persons Only) 14 17 20 24 34 49 54 64 999 (default if no endage is specified) datastream Stream Time-shifted viewing from DVR Playback or On-demand content with the same commercial load. If note specified, Live+SD will be the default. Live (Live - Includes viewing that occurred during the live airing). Live+SD (Live + Same Day - Includes all playback that occurred within the same day of the live airing). Live+3 (Live + 3 Days - Includes all playback that occurred within three days of the live airing). Live+7 (Live + 7 Days - Includes all playback that occurred within seven days of the live airing). feedpatterncode (required) String Defines feed pattern of calculations. (e.g. Live, Broadcast, Dual, or None ). Default is None datasource (required) String The source panel from which the ratings metrics are projected. "Household" - Total Household sample "Cable" - Wired cable sample. When a household is wired for cable, e.g. receives cable via a wire to the e home from a cable head-end located in the community. If a home is wired to receive cable channels on
any TV set in the homes, then the home is considered a wired cable home. "Hispanic" - NSIH Hispanic sample. Available for Miami, Los Angeles, New York, and Chicago markets. devicetype string To control what device breakouts are included. If null, TV Only is reported. Device types include: - TV: TV only - TV+Digital: All digital devices plus TV - TV+Mobile: All mobile devices plus TV - TV+Computer: Computer (PC Census) plus TV - Digital: All digital devices. Includes tablets, smartphones, Personal Media Players (PMPs), and computers (PC Census) - Mobile: Tablets, smartphones, and PMPs - Tablets: Tablets only - Smartphones: Smartphones only - PMPs: Portal Media Players only - Computer: Computer only (PC Census viewing only) metrics array[string] Specifies the metrics provided in the API response. aapercentage - Average Audience Percentage = The percentage of the target demographic viewing the selected station, aka Rating aaprojunits Average Audience expressed in units aaproj000 Average Audience expressed in thousands sharepercentage - The percent of Households or Persons using television tuned to a specific program / station in the market hutputpercentage- The percentage of all televisions households within
the market using their television sets during the specified quarter-hour hutputprojunits - The projected estimates of all television households within the market using their television sets during the quarterhour hutputproj000 - The projected estimates of all television households within the market using their television sets during the average minute of a specific time period, expressed in thousands ue000 - Universe Estimate (UE) is the total number of households or persons within the target demographic in the market intab - number of households or persons supplying usable information within the market marketid (required) Int Unique numerical identifier for the DMA (e.g. 501 for NY). Market IDs can be retrieved from the 'data availability' or 'markets' reference calls) stationid (required) Int Numerical ID code of the station (e.g. 5015 for WABC-TV 7.1 in the NY DMA). Station ID can be retrieved from the 'stations' reference call. Maximum one station can be passed in. programid Int Unique program identifier (e.g. 12345 ) telecastid int Unique numeric Identifier for each Telecast trackageid Int Trackage ID to provide a way of identifying which airing of the specific telecast trackagename String Client provided name to track each telecast Response Field broadcastdate broadcastdayofweekname Description The date on which the program originally aired (YYYY-MM- DD). The broadcast day of the week during which the program aired (e.g. THURSDAY ).
quarterhourstarttime quarterhourendtime gender startage endage datastream feedpatterncode datasource devicetype marketid marketname stationid stationname programid Start time of the quarter hour record End time of the quarter hour record Gender of the selected demographic. Start age of the demographic (Persons, Males, Females only) End age of the demographic (Persons, Males, Females only) Time-shifted viewing from DVR Playback or On-demand content with the same commercial load. Live (Live - Includes viewing that occurred during the live airing). Live+SD (Live + Same Day - Includes all playback that occurred within the same day of the live airing). Live+3 (Live + 3 Days - Includes all playback that occurred within three days of the live airing). Live+7 (Live + 7 Days - Includes all playback that occurred within seven days of the live airing). Feed pattern (None, Live, Dual, Broadcast) The source panel from which the ratings metrics are projected. To control what device breakouts are included. If null, TV Only is reported. Device types include: - TV: TV only - TV+Digital: All digital devices plus TV - TV+Mobile: All mobile devices plus TV - TV+Computer: Computer (PC Census) plus TV - Digital: All digital devices. Includes tablets, smartphones, Personal Media Players (PMPs), and computers (PC Census) - Mobile: Tablets, smartphones, and PMPs - Tablets: Tablets only - Smartphones: Smartphones only - PMPs: Portal Media Players only - Computer: Computer only (PC Census viewing only) DMA ID Name of the DMA Unique numerical station ID code. Call sign / name of station A unique numerical identifier for an individual program name.
programname Full program name. telecastid Unique numeric Identifier for each Telecast trackageid Trackage ID to provide a way of identifying which airing of the specific telecast trackagename Client provided name to track each telecast aapercentage Average Audience Percentage (e.g., Rating) - Estimated percentage of the universe of TV households (or other specified demographic group) tuned to a station at the same time. aaprojunits Average Audience Projection (Units) - The estimated number of viewers expressed in units (impressions). aaproj000 Average Audience Projection in thousands. sharepercentage (Impressions / HUT or PUT Impression) * 100 The percent of Households or Persons using television who are tuned to a specific program, station, or network in a specific area at a specific time. hutputpercentage Households Using Television (HUT) Percent % is the percentage of all television households in a geography with one or more sets in use during a specific time period. The sum of the average ratings for a given time period is sometimes higher than the HUT number because of households viewing multiple programs at the same time. If a household is watching two programs, it is counted toward each program rating but only once toward a HUT number. hutputprojunits HUT / PUT in units. hutputproj000 ue000 intab state HUT / PUT in thousands. Universe Estimate - the total number of households and persons 2+ within the designated characteristic, expressed in thousands. The number of households or persons supplying usable information for the report. Mandatory exclusions = @ Below minimum sample size = * (If Intab is below 45 for HH demographic or 16 for persons)
programratings Description: Program rating metrics for a specified broadcast date, market, station, data stream, sample, and demographic. Request URL: https://api.developer.nielsen.com/watchapi/local/monthlies/api/v1/programratings? Example URL: https://api.developer.nielsen.com/watchapi/local/monthlies/api/v1/programratings?broadcastdate=20 15-11- 28&reportStart=03%3A00&reportEnd=03%3A00&gender=Person&marketId=501&stationId=5015&data Source=Household&dataStream=Live%2BSD&feedPatternCode=None Parameter Name Parameter Description Type broadcastdate (required) Date Broadcast day of requested data in the following format: YYYY-MM-DD (e.g. 2015-12-10 ) reportstart string Report start time (e.g. HH:MM; 12:20 24- hour time). Optional field defaults to a full broadcast day, 03:00AM 03:00AM. reportend string Report end time (e.g. HH:MM; 13:20 24- hour time). Optional field defaults to a full broadcast day, 03:00AM 03:00AM. gender (required) string Gender of the target demographic. Households Person Male Female startage Int Youngest age of the target demographic (e.g. If target demographic is Persons 18-34, startage will be 18). 2 (default if no startage is specified, Available for persons only) 6 (Available for persons only) 12 15 18 21 25 35 50 55 65
endage Int Oldest age of the target demographic (e.g. If the target demographic is Persons 18-34, endage will be 34). 5 (Persons Only) 11 (Persons Only) 14 17 20 24 34 49 54 64 999 (default if no endage is specified) datastream Stream Time-shifted viewing from DVR Playback or On-demand content with the same commercial load. If note specified, Live+SD will be the default. Live (Live - Includes viewing that occurred during the live airing). Live+SD (Live + Same Day - Includes all playback that occurred within the same day of the live airing). Live+3 (Live + 3 Days - Includes all playback that occurred within three days of the live airing). Live+7 (Live + 7 Days - Includes all playback that occurred within seven days of the live airing). feedpatterncode (required) String Defines feed pattern of calculations. (e.g. Live, Broadcast, Dual, or None ). Default is None datasource (required) String The source panel from which the ratings metrics are projected. "Household" - Total Household sample "Cable" - Wired cable sample. When a household is wired for cable, e.g. receives cable via a wire to the e home from a cable head-end located in the community. If a home is wired to receive cable channels on
any TV set in the homes, then the home is considered a wired cable home. "Hispanic" - NSIH Hispanic sample. Available for Miami, Los Angeles, New York, and Chicago markets. devicetype string To control what device breakouts are included. If null, TV Only is reported. Device types include: - TV: TV only - TV+Digital: All digital devices plus TV - TV+Mobile: All mobile devices plus TV - TV+Computer: Computer (PC Census) plus TV - Digital: All digital devices. Includes tablets, smartphones, Personal Media Players (PMPs), and computers (PC Census) - Mobile: Tablets, smartphones, and PMPs - Tablets: Tablets only - Smartphones: Smartphones only - PMPs: Portal Media Players only - Computer: Computer only (PC Census viewing only) metrics array[string] Specifies the metrics provided in the API response. aapercentage - Average Audience Percentage = The percentage of the target demographic viewing the selected station, aka Rating aaprojunits Average Audience expressed in units aaproj000 Average Audience expressed in thousands sharepercentage - The percent of Households or Persons using television tuned to a specific program / station in the market hutputpercentage- The percentage of all televisions households within
the market using their television sets during the specified quarter-hour hutputprojunits - The projected estimates of all television households within the market using their television sets during the quarterhour hutputproj000 - The projected estimates of all television households within the market using their television sets during the average minute of a specific time period, expressed in thousands ue000 - Universe Estimate (UE) is the total number of households or persons within the target demographic in the market intab - number of households or persons supplying usable information within the market marketid (required) Int Unique numerical identifier for the DMA (e.g. 501 for NY). Market IDs can be retrieved from the 'data availability' or 'markets' reference calls) stationid (required) Int Numerical ID code of the station (e.g. 5015 for WABC-TV 7.1 in the NY DMA). Station ID can be retrieved from the 'stations' reference call. Maximum one station can be passed in. programid Int Unique program identifier (e.g. 12345 ) Response Field broadcastdate broadcastdayofweekname gender startage endage Description The date on which the program originally aired (YYYY-MM- DD). The broadcast day of the week during which the program aired (e.g. THURSDAY ). Gender of the selected demographic. Start age of the demographic (Persons, Males, Females only) End age of the demographic (Persons, Males, Females only)
datastream feedpatterncode datasource devicetype marketid marketname stationid stationname programid programname telecaststarttime telecastendtime totalduration episodeid episodetitle telecastid trackageid trackagename Time-shifted viewing from DVR Playback or On-demand content with the same commercial load. Live (Live - Includes viewing that occurred during the live airing). Live+SD (Live + Same Day - Includes all playback that occurred within the same day of the live airing). Live+3 (Live + 3 Days - Includes all playback that occurred within three days of the live airing). Live+7 (Live + 7 Days - Includes all playback that occurred within seven days of the live airing). Feed pattern (None, Live, Dual, Broadcast) The source panel from which the ratings metrics are projected. To control what device breakouts are included. If null, TV Only is reported. Device types include: - TV: TV only - TV+Digital: All digital devices plus TV - TV+Mobile: All mobile devices plus TV - TV+Computer: Computer (PC Census) plus TV - Digital: All digital devices. Includes tablets, smartphones, Personal Media Players (PMPs), and computers (PC Census) - Mobile: Tablets, smartphones, and PMPs - Tablets: Tablets only - Smartphones: Smartphones only - PMPs: Portal Media Players only - Computer: Computer only (PC Census viewing only) DMA ID Name of the DMA Unique numerical station ID code. Call sign / name of station A unique numerical identifier for an individual program name Full program name Exact time when the telecast started Exact time when the telecast ended Total duration of the program Unique ID number for an episode Name of the episode Unique numeric Identifier for each Telecast Trackage ID to provide a way of identifying which airing of the specific telecast Client provided name to track each telecast
aapercentage Average Audience Percentage (e.g., Rating) - Estimated percentage of the universe of TV households (or other specified demographic group) tuned to a station at the same time. aaprojunits Average Audience Projection (Units) - The estimated number of viewers expressed in units (impressions). aaproj000 Average Audience Projection in thousands. sharepercentage (Impressions / HUT or PUT Impression) * 100 The percent of Households or Persons using television who are tuned to a specific program, station, or network in a specific area at a specific time. hutputpercentage Households Using Television (HUT) Percent % is the percentage of all television households in a geography with one or more sets in use during a specific time period. The sum of the average ratings for a given time period is sometimes higher than the HUT number because of households viewing multiple programs at the same time. If a household is watching two programs, it is counted toward each program rating but only once toward a HUT number. hutputprojunits HUT / PUT in units. hutputproj000 ue000 intab state HUT / PUT in thousands. Universe Estimate - the total number of households and persons 2+ within the designated characteristic, expressed in thousands. The number of households or persons supplying usable information for the report. Mandatory exclusions = @ Below minimum sample size = * (If Intab is below 45 for HH demographic or 16 for persons)
quarterhourbulkratings Description: Quarter-hour ratings metrics for all 26 building block demographics for a specified broadcast date, market, station, data stream, and sample. Request URL: https://api.developer.nielsen.com/watchapi/local/monthlies/api/v1/quarterhourbulkratings? Example URL: https://api.developer.nielsen.com/watchapi/local/monthlies/api/v1/quarterhourbulkratings?broadcast Date=2015-11- 28&reportStart=03%3A00&reportEnd=03%3A00&marketId=501&stationId=5015&data Source=Household&dataStream=Live%2BSD&feedPatternCode=None Parameter Name Parameter Description Type broadcastdate (required) Date Broadcast day of requested data in the following format: YYYY-MM-DD (e.g. 2015-12-10 ) reportstart string Report start time (e.g. HH:MM; 12:20 24- hour time). Optional field defaults to a full broadcast day, 03:00AM 03:00AM. reportend string Report end time (e.g. HH:MM; 13:20 24- hour time). Optional field defaults to a full broadcast day, 03:00AM 03:00AM. datastream Stream Time-shifted viewing from DVR Playback or On-demand content with the same commercial load. If note specified, Live+SD will be the default. Live (Live - Includes viewing that occurred during the live airing). Live+SD (Live + Same Day - Includes all playback that occurred within the same day of the live airing). Live+3 (Live + 3 Days - Includes all playback that occurred within three days of the live airing). Live+7 (Live + 7 Days - Includes all playback that occurred within seven days of the live airing). devicetype string To control what device breakouts are included. If null, TV Only is reported. Device types include: - TV: TV only - TV+Digital: All digital devices plus TV - TV+Mobile: All mobile devices plus TV - TV+Computer: Computer (PC Census) plus TV
- Digital: All digital devices. Includes tablets, smartphones, Personal Media Players (PMPs), and computers (PC Census) - Mobile: Tablets, smartphones, and PMPs - Tablets: Tablets only - Smartphones: Smartphones only - PMPs: Portal Media Players only - Computer: Computer only (PC Census viewing only) feedpatterncode (required) String Defines feed pattern of calculations. (e.g. Live, Broadcast, Dual, or None ). Default is None datasource (required) String The source panel from which the ratings metrics are projected. "Household" - Total Household sample "Cable" - Wired cable sample. When a household is wired for cable, e.g. receives cable via a wire to the e home from a cable head-end located in the community. If a home is wired to receive cable channels on any TV set in the homes, then the home is considered a wired cable home. "Hispanic" - NSIH Hispanic sample. Available for Miami, Los Angeles, New York, and Chicago markets. metrics array[string] Specifies the metrics provided in the API response. aapercentage - Average Audience Percentage = The percentage of the target demographic viewing the selected station, aka Rating aaprojunits Average Audience expressed in units aaproj000 Average Audience expressed in thousands sharepercentage - The percent of Households or Persons using
television tuned to a specific program / station in the market hutputpercentage- The percentage of all televisions households within the market using their television sets during the specified quarter-hour hutputprojunits - The projected estimates of all television households within the market using their television sets during the quarterhour hutputproj000 - The projected estimates of all television households within the market using their television sets during the average minute of a specific time period, expressed in thousands ue000 - Universe Estimate (UE) is the total number of households or persons within the target demographic in the market intab - number of households or persons supplying usable information within the market marketid (required) Int Unique numerical identifier for the DMA (e.g. 501 for NY). Market IDs can be retrieved from the 'data availability' or 'markets' reference calls) stationid (required) Int Numerical ID code of the station (e.g. 5015 for WABC-TV 7.1 in the NY DMA). Station ID can be retrieved from the 'stations' reference call. Maximum one station can be passed in. programid Int Unique program identifier (e.g. 12345 ) telecastid int Unique numeric Identifier for each Telecast trackageid Int Trackage ID to provide a way of identifying which airing of the specific telecast trackagename String Client provided name to track each telecast Response Field broadcastdate Description The date on which the program originally aired (YYYY-MM- DD).
broadcastdayofweekname quarterhourstarttime quarterhourendtime gender startage endage datastream devicetype feedpatterncode datasource marketid marketname stationid The broadcast day of the week during which the program aired (e.g. THURSDAY ). Start time of the quarter hour record End time of the quarter hour record Gender of the selected demographic. Start age of the demographic (Persons, Males, Females only) End age of the demographic (Persons, Males, Females only) Time-shifted viewing from DVR Playback or On-demand content with the same commercial load. Live (Live - Includes viewing that occurred during the live airing). Live+SD (Live + Same Day - Includes all playback that occurred within the same day of the live airing). Live+3 (Live + 3 Days - Includes all playback that occurred within three days of the live airing). Live+7 (Live + 7 Days - Includes all playback that occurred within seven days of the live airing). To control what device breakouts are included. If null, TV Only is reported. Device types include: - TV: TV only - TV+Digital: All digital devices plus TV - TV+Mobile: All mobile devices plus TV - TV+Computer: Computer (PC Census) plus TV - Digital: All digital devices. Includes tablets, smartphones, Personal Media Players (PMPs), and computers (PC Census) - Mobile: Tablets, smartphones, and PMPs - Tablets: Tablets only - Smartphones: Smartphones only - PMPs: Portal Media Players only - Computer: Computer only (PC Census viewing only) Feed pattern (None, Live, Dual, Broadcast) The source panel from which the ratings metrics are projected. DMA ID Name of the DMA Unique numerical station ID code.
stationname Call sign / name of station programid A unique numerical identifier for an individual program name. programname Full program name. telecastid Unique numeric Identifier for each Telecast trackageid Trackage ID to provide a way of identifying which airing of the specific telecast trackagename Client provided name to track each telecast aapercentage Average Audience Percentage (e.g., Rating) - Estimated percentage of the universe of TV households (or other specified demographic group) tuned to a station at the same time. aaprojunits Average Audience Projection (Units) - The estimated number of viewers expressed in units (impressions). aaproj000 Average Audience Projection in thousands. sharepercentage (Impressions / HUT or PUT Impression) * 100 The percent of Households or Persons using television who are tuned to a specific program, station, or network in a specific area at a specific time. hutputpercentage Households Using Television (HUT) Percent % is the percentage of all television households in a geography with one or more sets in use during a specific time period. The sum of the average ratings for a given time period is sometimes higher than the HUT number because of households viewing multiple programs at the same time. If a household is watching two programs, it is counted toward each program rating but only once toward a HUT number. hutputprojunits HUT / PUT in units. hutputproj000 ue000 intab state HUT / PUT in thousands. Universe Estimate - the total number of households and persons 2+ within the designated characteristic, expressed in thousands. The number of households or persons supplying usable information for the report. Mandatory exclusions = @ Below minimum sample size = * (If Intab is below 45 for HH demographic or 16 for persons)