Musical Products

get

https://api.luminatedata.com/musical_products/{id}

Receive metadata and consumption data for a Musical Product using a Luminate ID or (external_ids) ICPN or GRID.

Path Params

string

required

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

Query Params

id_type

string

enum

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.

Allowed:

location

string

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.

start_date

string

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.

end_date

string

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.

chart_week

string

^\d{4}-W\d{2}

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).

metadata_level

string

enum

Specify the volume of metadata returned in the response.

Allowed:

external_ids

string

enum

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

Allowed:

relationships

array of strings

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

relationships

Allowed:

metrics

array of strings

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 Product metadata.

metrics

Allowed:

atd

array of strings

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).

atd

Allowed:

breakouts

array of strings

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).

breakouts

aggregate_interval

string

enum

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

Allowed:

markets

array of strings

Retrieve the consumption data for one or multiple markets in the United States or Canada. Note: The Location ID and Market ID must correspond. Full list of supported markets can be found in the "Luminate IDs" folder in the Guides tab.

markets

market_filter

array of strings

Filter the consumption data by one or multiple markets.

market_filter

commercial_model

string

enum

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

Allowed:

service_type

string

enum

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

Allowed:

content_type

string

enum

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

Allowed:

sales_type

array of strings

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

sales_type

Allowed:

distribution_channel

string

enum

Filter the product sales data by digital or physical sales.

Allowed:

purchase_method

string

enum

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

Allowed:

store_strata

array of strings

Filter the product sales data by the strata type.

store_strata

Allowed:

product_format

array of strings

Filter the product sales data by the format type.

product_format

Response

200OK