v1

latestOpenAPI 3.0.12026-07-24207094.9 KB
Artists

Artists

Receive metadata and consumption data for an Artist using a Luminate ID or ISNI.

get/artists/{id}

Path parameters

idstring required

Unique Luminate ID assigned to the Artist.

Example:ID

Unique Luminate ID assigned to the Artist.

Query parameters

id_type'luminate' | 'isni'

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.

locationstring

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.

Example:US

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_datestring

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.

Example:2023-01-01

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_datestring

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.

Example:2023-01-14

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_weekstring

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

Example:2023-W14

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'max' | 'min'

Specify the volume of metadata returned in the response.

external_ids'true' | 'false'

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

relationshipsstring[]

Retrieve a list of entities that are associated with the specified Artist. Multiple values can be entered in a single request (comma-separated).

metricsstring[]

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

atdstring[]

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

breakoutsstring[]

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

aggregate_interval'total' | 'day' | 'week' | 'chart_week'

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

marketsstring[]

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.

market_filterstring[]

Filter the consumption data by one or multiple markets.

commercial_model'ad_supported' | 'premium' | 'none'

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

service_type'on_demand' | 'programmed' | 'none'

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

content_type'audio' | 'video' | 'none'

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

sales_typestring[]

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

distribution_channel'digital' | 'physical' | 'none'

Filter the product sales data by digital or physical sales.

purchase_method'online' | 'storefront' | 'none'

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

store_stratastring[]

Filter the product sales data by the strata type.

product_formatstring[]

Filter the product sales data by the format type.

release_typestring[]

Filter the product sales data by the release type.

discography'musical_release_group' | 'song' | 'none'

Retrieve a list of Musical Release Groups or Songs that are attributed to the specified Artist.

airplay_formatsstring[]

Retrieve the airplay data for one or multiple airplay formats. Full list of supported airplay formats can be found in the "Luminate IDs" folder in the Guides tab.

airplay_format_filterstring

Filter the airplay data by an airplay format.

Headers

Accept'application/vnd.luminate-data.svc-apibff.v1+json'

Response

OK