YouScan's API is available to Insight plan subscribers.

What kind of data can I obtain through API?

You can obtain various statistics from the topic. Like the number of mentions, the breakdown by sentiment, and the word cloud.


You can find the documentation here: https://youscan.docs.apiary.io

Limiting access to certain topics

Each API key is tied to a specific user. This user can only use their own API key to access the topics that they have permission to see

You can check which users have an API key in the Account Settings under Users

💡We recommend creating a special support user account for API work. This allows you to be flexible with your topic permissions

How to create an API key

  1. Log in to YouScan with the credentials of the user who needs an API key. 
  2. Go to My Settings.
  3. In the API Key section, select "Create."

☝️ Remember to copy your key once prompted and save it in a secure space; you cannot view it again.

How to recreate an API key

  1. Log in to YouScan with the credentials of the user who needs to recreate their API key. 
  2. Go to My Settings.
  3. In the API Key section, select "Recreate."

Good luck with your data work! We're happy to answer any questions about YouScan API via chat (blue speech bubble in the bottom-right corner).

Did this answer your question?