Musical Release Groups

Unique Luminate ID, ICPN, or GRID assigned to the Musical Release Group.

Use the id_type parameter to specify the source of the ID. If the id_type is not specified, the endpoint will expect a Luminate ID.

Geographic territory used in the aggregation of the consumption data. Value must be formatted according to the ISO 3166-1 alpha-2 standard. Full list of supported locations can be found in the "Luminate IDs" folder in the Guides tab.

First date used in the aggregation of the consumption data. Value must be formatted according to the ISO 8601 date standard (YYYY-MM-DD). If the start_date is not specified, the default value is 7 days prior to the current date or 7 days prior to the end_date.

Last date used in the aggregation of the consumption data. Value must be formatted according to the ISO 8601 date standard (YYYY-MM-DD). If the end_date is not specified, the default value is the current date or 7 days after the start_date.

Represents the 7-day period (Fri-Thur) used in the aggregation of consumption data. Value must be formatted according to the ISO 8601 week standard (YYYY-Www).

Specify the volume of metadata returned in the response.

Retrieve a list of additional IDs that are associated to the specified Musical Release Groups.

Retrieve a list of entities that are associated to the specified Musical Release Group. Multiple values can be entered in a single request (comma separated).

Specify the desired consumption metrics in the output. Multiple values can be entered in a single request (comma separated). Specifying "none" would exclude all of the consumption data and return only the Musical Release Group metadata.

ATD (activity-to-date) will provide a value that reflects all of the historical activity for the corresponding metric up to the end_date in the request. Multiple values can be entered in a single request (comma separated).

Breakouts are categorizations of the consumption data. For this endpoint, breakouts are available only for the streaming data. Specify which of the streaming breakouts are included in the response. Multiple values can be entered in a single request (comma separated).

This parameter enables additional time-based aggregations of consumption data that are shown instead of the "total" value.

Filter the streaming data by ad-supported or premium streams.

Filter the streaming data by on-demand or programmed streams.

Filter the streaming data by audio or video streams. Note: Content Type data is only available in the following locations: US, CA, AA.

Specify the type of sales that are displayed within the Sales metric.

Filter the product sales data by digital or physical sales.

Filter the product sales data by online or in-store sales.

Filter the product sales data by the strata type.

Filter the product sales data by the format type.

Filter the airplay data by an airplay format.