Sonar User Guide

Getting Started with Sonar:

Sonar is a tool for tracking and reviewing your deliveries to Spotify. With Sonar,   you’ll be able to track your content from the point it's delivered to us, monitor it through the processing stage, and confirm its successful ingestion into our CMS. You’ll also be able to review any ingestion or transcoding errors your content may encounter, with messaging provided on the nature of the error.

 

Who can access Sonar?

Sonar is only available to providers that deliver to Spotify via a direct feed (either a direct SFTP connection or Uplink). If you are interested in delivering to us via either of these methods, please reach out to our Licensing team at external-licensing@spotify.com.

 

How do I access Sonar?

Sonar is directly accessible at https://sonar.spotify.com/

If you are unable to access Sonar, and you believe you meet the criteria for access above - please reach out to content-ops+ingestion@spotify.com

 

Searching in Sonar:

To search for products or deliveries in Sonar, you can use a Primary Release ID and/or a Batch ID.

Primary Release ID: This is the primary identifier associated with the release or product in question. This is commonly a UPC or EAN, but it could be any value used to identify a release - such as a GRID, Catalog Number or any other unique proprietary ID. The Primary Release ID will only correspond to the product’s folder name within its delivery batch, so please note that any other identifiers delivered for this release will not be searchable.

Batch ID: This is the identifier associated with a specific delivery batch folder, containing at least one product you have delivered to us. The identifier should derive from the date and time of its creation in the form of a timestamp (YYYYMMDDhhmmssnnn). 

You are able to search multiple Primary Release IDs and/or Batch IDs in Sonar by entering each value separated by a comma. 

 

Using the filters:

Product Status:

    • Has errors: Selecting this filter will return products that have encountered any ingestion or transcoding errors. This filter will generate all recorded errors for a product, and will not account for any successful redeliveries or resolutions.
      • More information on errors can be found in the Reviewing and resolving errors section.
    • Has unresolved errors: This filter will only return products where the latest product status is in error - this will help you identify exactly which products you need to redeliver right now. In contrast to the Has errors filter above, this filter does take successful re-deliveries and resolutions into account - and will no longer return a product that has since ingested successfully. While this filter is selected, you will be unable to select any others. 
      • More information on errors can be found in the Reviewing and resolving errors section.
    • Processing: Selecting this filter will return products that are currently processing. Processing begins as soon as your delivery is picked up from our server, and concludes when a product has either successfully ingested or has encountered some form of error.
    • Ingested: Selecting this filter will return products that have successfully ingested into our CMS without any errors. 

Date Range:

    • Sonar provides an option for toggling various date ranges with which to restrict your search results to. The default date range is Last 28 days, but you have the ability to search the Last 7 days, the Last 90 days or set a Custom Date Range.

 

Reviewing your search results:

Using your chosen parameters, Sonar returns results in individual rows on the results table - with each row corresponding to a product. In addition to Feed name, Primary Release ID, Batch ID and Product Status, we also return the date and time we received the delivery (Date Delivered - UTC), and the last delivery event for the specific batch (Last Updated).

Each row can also be expanded to review further delivery details around audio and image transcoding, ingestion and any errors present - including any errors that may be specific to the individual tracks on a product.

 

Reviewing and resolving errors:

Whenever a product is flagged as having an error, you will be able to view additional information by expanding the row using the arrow icon. An error will be any issue encountered that is preventing the ingestion or transcoding of your content.

XML errors: 

    • XML errors occur when the XML metadata file contained in a product delivery is incorrectly structured or missing the necessary information. In these cases, it is likely that the XML file may not have been delivered in line with the DDEX standard (ERN 3.8.2 and above).
    • To resolve XML errors, we recommend:
      • Verifying that the XML metadata file you are delivering is in line with the DDEX standard (see our Spotify Onboarding Guidelines here for more).
      • Verifying that you are not delivering a metadata update for a product we have not yet received as an insert, and that has not been ingested into our CMS.
      • Verifying that the metadata update you are delivering does not alter the disc structure or tracklist of the product as it exists in our CMS.
    • Once you are able to verify the above, you can queue a full asset re-delivery or metadata update (only if we have already ingested this product successfully). If you are still receiving XML errors at this point, please reach out to content-ops+ingestion@spotify.com with full details of the product, the batch and the error message.

Audio errors:

    • Audio errors occur when we receive audio assets in a delivery that we are unable to process. In these cases, the audio file is likely either corrupt or has not been delivered to our audio file specifications (see our Spotify Onboarding Guidelines here for more).
    • To resolve audio errors, we recommend verifying that your audio files are:
    • Once you are able to verify the above, you can queue a full asset re-delivery. If you are still receiving audio errors at this point, please reach out to content-ops+ingestion@spotify.com with full details of the product, the batch and the error message.

Image errors:

    • Image errors occur when we receive image assets in a delivery that we are unable to process. In these cases, the image file is likely either corrupt or has not been delivered to our image file specifications (see our Spotify Onboarding Guidelines here for more).
    • To resolve image errors, we recommend verifying that your image files are:
    • Once you are able to verify the above, you can queue a full asset re-delivery. If you are still receiving image errors at this point, please reach out to content-ops+ingestion@spotify.com with full details of the product, the batch and the error message.

Delivery errors:

    • Delivery errors occur when we are unable to process a batch after it has been dropped onto our SFTP delivery servers. Issues here typically stem from problems with the batch itself - including structural issues, or formatting errors in the batchcomplete or batch manifest file.
    • To resolve delivery errors, we recommend:
      • Verifying SFTP logs to confirm successful connection and delivery of the batches onto our delivery servers.
      • Investigating the structure of the batch, ensuring it is in line with the DDEX standard (see our Spotify Onboarding Guidelines here for more).
      • Ensuring that the format of the batchcomplete or manifest file is accurate, and reflects the products contained in the batch correctly.
    • Once you are able to verify the above, please attempt a re-delivery. If you are still receiving delivery errors at this point, please reach out to content-ops+ingestion@spotify.com with full details of the batch and the error message.

 

Downloading your results:

Next to the filters, there is an arrow icon that will allow you to download your results table as a CSV file. This file will only include results that are specific to the search parameters you have selected. 

In this version of the results table, you may see errors broken out track by track into individual rows with the error details pertaining specifically to each track. This contrasts with the results table directly in Sonar, which requires expanding a product row to see any track-level errors. 

 

FAQs:

I have Sonar admin access, how do I add my colleagues to Sonar?

  1. Log in to artists.spotify.com.
  2. Click the 3 dots in the top-left.
  3. Select Your teams, then the team you want to invite them to (if you’re in multiple teams).
  4. Fill in the team member’s info, or click BULK INVITE to invite multiple team members.
  5. Click SEND INVITE.

We’ll send them an email with a few steps to follow, then they’re in.

 

How far back can the search results in Sonar go? 

The delivery history in Sonar goes as far back as November 2020, which is when we first started logging the delivery history for this specific purpose. Sonar does not provide a full record of any deliveries prior to this date.

I cannot understand or am unsure how to resolve a specific error, what should I do?

In the event you encounter an error you are unsure how to resolve or cannot interpret, please reach out to content-ops+ingestion@spotify.com with full details of the product, the batch and the error message. 

Why are errors not disappearing as I resolve them?

When selecting the Has errors filter in Sonar, a search will generate all recorded errors for a product, and will not account for any successful redeliveries or resolutions. In order to only see products that are still in error status, you can select Has unresolved errors - which does take successful re-deliveries and resolutions into account. In this view, a search will no longer return a product that has since ingested successfully.

Does Sonar indicate when a product will go live?

Sonar is specifically designed to track and review product deliveries, and does not provide any visibility into live status. As always, please ensure you are delivering in line with our Service Level Guideline.

My product has had the status Processing for longer than usual, what should I do?

In general, a product should not have a status of Processing for any longer than 3 hours (and typically, processing will complete in less time than this). In the event that a product is in Processing for over 3 hours, please reach out to content-ops+ingestion@spotify.com with full details of the product and the batch.

My product says it ‘Has errors’, but I see that it is available in the CMS?

The audio and/or image assets on a product may fail to transcode, and still ingest into our CMS. Despite this, we do not consider this scenario a successful ingestion - and therefore it would not have a status of Ingested in Sonar. If your product is in the CMS but has transcoding errors in Sonar, please review and resolve these errors - as they will ultimately prevent your product from going live as desired.

How do I add new users onto Sonar?

Only admin users will be manage users onto Sonar. If you are an admin for your organisation, you will have the ability to add or remove users in the Spotify for Artists tool.

How can I provide feedback on or suggestions for Sonar?

Any feedback you could provide on Sonar would be highly valuable, and would help us to make it the best tool possible. In order to do this, please submit your feedback via our Sonar Feedback Form. Your feedback will go directly to our engineering and product team here at Spotify.

How long does it take for a delivery to appear in Sonar?

Deliveries should display in Sonar as close to real-time as possible. You should expect to be able to search your products shortly after you have dropped them onto our delivery server. 

If you are still unable to locate a specific delivery in Sonar 3 hours after delivering, please attempt a re-delivery - ensuring there are no SFTP connection issues. Please also confirm you are searching using the correct Batch ID and/or Primary Release ID.

If the issue persists, please reach out to content-ops+ingestion@spotify.com with full details of the product and the batch.

I am able to locate a product, but not with the Product Identifier of my choice:

Products in Sonar are identified by Primary Release ID. This is the primary identifier associated with the release or product in question. The Primary Release ID will only correspond to the product’s folder name within its delivery batch, so please note that any other identifiers delivered within the XML for this release will not be searchable. 

I am not seeing the correct content in Sonar:

If you are not seeing the content you expect to be able to see in Sonar, please reach out to content-ops+ingestion@spotify.com with a UPC or URI for a product you would expect to see - as well as the feed name. Similarly, if you are seeing content that you do not expect to see - please supply the UPC(s) and feed name(s) in question.



Was this article helpful?