Home
Track Object
Schema
When you retrieve a Track, you get the following object:
{
"id": "",
"outer_id": "",
"catalog_ids": [
""
],
"primary_media": ""
}
This is the minimal schema, but you could decide to get more outputs for each entry. In this case, the object could be such as the following:
{
"id": "",
"outer_id": "",
"catalog_ids": "",
"primary_media": "",
"title": "",
"isrc": "",
"lyrics": "",
"release_date": "",
"albums": [],
"artists": [],
"customer_tags": [],
"products": [],
"logs": [],
"references": []
}
Descriptions
| Key | Value Type | Description | Output |
|---|---|---|---|
| id | string | Musimap Internal Unique Identifier for this entry. | |
| outer_id | string | Your own unique identifier for this entry. | |
| catalog_ids | list | A list of all catalogs that contain this entry. | |
| primary_media | string | The AWS S3 FileURI that is used for this entry. | |
| title | string | If any, the title of this entry. | details,all |
| isrc | string | If any, the ISRC related to this entry. | details,all |
| lyrics | string | if any, the lyrics related to this entry. | details,all |
| release_date | string | if any, the date of release for this entry. | details,all |
| albums | list | if any, a list of all albums that contain this entry. | details,all |
| artists | list | if any, a list of all artists that contribute to this entry. | details,all |
| customer_tags | list | if any, a list of your own tags you would like us to save. | details,all |
| products | list | if any, a list of the Musimap products that support this entry. | products,all |
| logs | list | A list of all the events that have impacted this entry. | logs,all |
| references | list | if any, a list of references related to this entry. | references,all |
Product Object
The products are related to a specific entry. It uses the primary_media to first analyze the audio file, then compute the product itself (musimatch or musimotion).
Therefore, an entry could be analyzed but not available yet.
| Key | Value(s) | Description |
|---|---|---|
| product | musimatch or musimotion | The product that needs to be licensed. |
| version | v2.1 or v1.4 | The version of the product. Should be valide while associated with a product. |
| status | pending, failed or success | pending if the entry is being processed. failed or success depending on the analysis. |
| available | true or false | Whether this entry is fully available for the related product. |
| available_at | timestamp (ms) | Timestamp related to the last update of available. |
| status_at | timestamp (ms) | Timestamp related to the last update of status. |