{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"44ce3a51-d431-4f9a-9e79-d2f8646c6c22","name":"Ei External API","description":"# Introduction\n\nEntertainment Intelligence (Ei) provide this API as a means of searching for assigned catalogue and then exporting each entities underlying trends (streaming, download and video) consumption data.
\n

Entities

\n\nEach API user will have been granted access to some or all of an Ei clients catalogue, at the client's discretion. This exposes entities that form a hierarchy of Imprints (record labels), Artists, Products (albums and videos) and Tracks.
\n

Endpoints

\n\nTop - The top x results for an entity, with basic display details
\nList - Same result as \"Top\" but with a data broken out. With option to \"include\" timeseries data
\nDetails - Expanded details for a single entity, with options \"include\" demographics, sources of stream, devices, vendors and territories. Can also \"include\" associated entities
\n\n# Overview\n

Catalog endpoints:

\n\n/imprints/top
\n/imprints/list
\n/imprints/details/:id
\n\n/artists/top
\n/artists/list
\n/artists/details/:id
\n\n/products/top
\n/products/list
\n/products/details/:id
\n\n/tracks/top
\n/tracks/list
\n/tracks/details/:id
\n\n/playlists/top
\n/playlists/list
\n/playlists/details/:id
\n\nThese endpoints have following query string parameters:
\nstart - required - date string
\nend - required - date string
\nprev_start - optional - date string
\nprev_end - optional - date string
\nrelease_start - optional - date string
\nrelease_end - optional - date string
\nlimit - optional - numeric
\npage - optional - numeric
\n\nResults can be filtered by one or several comma-separated lists of IDs.
\nimprints
\nproduct_artists
\ntrack_artists
\nproducts
\ntracks - list of track IDs
\nisrcs - list of track ISRCs
\nterritories - list of alpha-2 country codes (https://github.com/samayo/country-json/blob/master/src/country-by-abbreviation.json)
\nvendors - list of vendor IDs, please see table below
\n\n/list and /top have an optional include=timeseries parameter
\n/details have following options to include:
\nvendors
\nterritories
\nsources
\ndevices
\ndemographics (age group and gender)
\nimprints
\nartists
\nproducts
\ntracks
\n\nExamples:
\n/imprints/top?start=2020-01-01&end=2020-01-02\n/artists/top?start=2020-01-01&end=2020-01-02&territories=US&vendors=1,2&imprints=75\n/products/list?start=2020-01-01&end=2020-01-02&include=timeseries\n/tracks/details/27996?start=2020-01-01&end=2020-01-02&include=demographics,vendors\n\n

Search endpoint:

\n/search
\n/search/playlists
\n\nIt has following query string parameters:
\nsearch - required - string
\nentities - optional - comma-separated list of entities (e.g. “imprints,artists”) if empty, all 4 entities are searched
\nPlaylist search can include Name or Vendor ASIN
\n\nExample:
\n/search?search=records&entities=imprints\n/search?search=XYZGBAAN8000017&entities=tracks\n\n# Glossary\n

Vendors

\n1 - Spotify
\n2 - Apple Music
\n3 - iTunes
\n4 - Deezer
\n5 - Google
\n9 - Amazon
\n11 - Youtube
\n12 - Pandora
\n13 - SoundCloud
\n15 - Shazam
\n\n

Trends Data

\nprev_units - Total for \"previous period\", either as default or specified
\ncurr_units - Total for \"current period\"
\nunits_diff - Difference between prev_units and curr_units
\npassive - Listeners who have not search for or saved the track that was played
\nactive - Streams coming from search, artist or album page, listeners collection or named playlists
\nengaged - Ratio of active vs passive listeners
\ncurr_skipped - Streams that were skipped before 90% of the track was played
\nskipped_ratio - Skips as a percentage of total streams
\ncurr_completed - Streams that completed
\ncompleted_ratio - Completed as a percentage of total streams
\nsub30 - Non royalty bearing streams, those skipped before 30 seconds
\nsaves - Tracks saved to a listeners library (collection)
\nsaves_ratio - Percentage of streams that went on to be saved
\ndiscovery - First time listener heard the track
\ndiscovery_ratio - Percentage of streams that were flagged as discovery
\nprev_playlists - Count of playlists for \"previous period\"
\ncurr_playlists - Count of playlists for \"current period\"
\nplaylists_diff - Growth or decline in playlists
\ncurr_products - Count of products associated to the entity
\ncurr_tracks - Count of tracks associated to the entity
\ncurr_male - Total by male listener for \"current period\"
\ncurr_female - Total by female listener for \"current period\"
\ncurr_unknown - Total by unknown listener for \"current period\"
\nfree - Total by free listener account for \"current period\"
\nfree_ratio - Percentage of streams that were on free accounts
\ndiscounted - Total by discounted listener account for \"current period\"
\ndiscounted_ratio - Percentage of streams that were on discounted accounts
\npremium - Total by premium listener account for \"current period\"
\npremium_ratio - Percentage of streams that were on premium accounts
\ncontent_type - stream, video, radio, download, social music
\n\n

Metadata

\nimprint_id - Internal identifier for the imprint
\nimprint_name
\nartist_id - Internal identifier for the artist
\nartist_name
\nproduct_id - Internal identifier for the product
\nproduct_title
\nproduct_version
\nupc - Industry identifier for the product
\nproduct_genre
\noriginal_release_date
\nrelease_date
\ntrack_id - Internal identifier for the track
\ntrack_title
\ntrack_version
\nisrc - Industry track identifier
\ntrack_genre - Genre list defined by clients
\nlogo - Thumbnail for display purposes
\nimage - URL to Ei hosted images
\nterritory - ISO2 territory code
\nterritory_name
\npopulation - Territory population
\nperCapita - Total divided by territory population
\ngender - Male, Female, Unknown
\nage - 1-17, 18-24, 25-34, 35-44, 45-54, 55-64, 65+
\n\n# Authentication\nEvery request should include “apikey” header.
\nYour API key can be found in the dashboard:\nhttps://enterlytics-dev.entertainment-intelligence.com/user-preferences/api\n\nExample:\ncurl -H \"apikey: YOUR_API_KEY\" https://enterlytics-api-dev.entertainment-intelligence.com/\n\n# Error Codes\n400 - validation error, it returns a JSON array of invalid fields
\n401 - authentication problem, invalid token
\n500 - API error, problem with upstream API
\n\n# Rate limit\nEi is a \"mass data\" service, hitting billions of lines of data at every request, therefore it is important to observe these entity and page limiting rules.
\n\nBy default, prev_start and prev_end is a period of the same length as start-end directly before it. E.g. if start is 08-01-2021 and end is 14-01-2021 then prev_start would be 01-01-2021 and prev_end would be 07-01-2021.
\n\nThe default response limit is 10 entries.\n\n# Terms and Conditions\n\nThis API is the intellectual property of Entertainment Intelligence Limited (Ei).
\n\nAPI access is granted conditional on the understanding that all content, data, processes, insights and/or benchmarks are confidential and proprietary and may not be revealed to any other parties without the express written permission of EI.
\n\nAny sales or trends data provided in this API will be assigned by the Ei client (Client) via their user access control portal. All such data is proprietary and confidential and may not be shared except as otherwise expressly allowed under written agreement between Client and you.
\n\nEi and the client reserve the right to withdraw access to this service or the data at any time and without notice.
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"15873666","team":1920035,"collectionId":"44ce3a51-d431-4f9a-9e79-d2f8646c6c22","publishedId":"TzXumf8k","public":true,"publicUrl":"https://api.entertainment-intelligence.com","privateUrl":"https://go.postman.co/documentation/15873666-44ce3a51-d431-4f9a-9e79-d2f8646c6c22","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.6","publishDate":"2021-05-27T06:01:45.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/0a427a545fd1927999d1f574f9280863354c254c4ba09cfcb707e706d3cfeb3e","favicon":"https://entertainment-intelligence.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api.entertainment-intelligence.com/view/metadata/TzXumf8k"}