Our API data is available to subscribers of Analyze plans and up for an additional fee. Please contact your customer success manager or get in touch with us at support@youscan.io to find out more information.

What kind of data you can get through API

You can work with 2 types of data:

  • any metrics from monitoring topics, such as the number of mentions, breakdown by sentiment, or word cloud.

  • mentions full text

Documentation: https://youscan.docs.apiary.io/

Are there any source limitations?

Data from the following sources is unavailable:

  • Reddit

  • Quora

  • some small sources

We are limiting the data which can be accessed for mentions collected from Twitter. The next adjustments are applied:

  • Mention's Text and Full Text properties are removed

  • Mention URL is removed

  • Author URL is removed

  • Profile ID of the author is added to Author information (the ID itself is the ID of the Twitter Profile)

  • Post ID is the ID of Tweet

Combining Profile ID and Post ID allows you to navigate to the exact Tweet which was collected as the corresponding mention.

Can I limit access to certain topics?

Yes, the API keys are attached to specific users. The API will only contain the topics accessible to that user within the YouScan interface.

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

💡 We recommend setting up a test user to be flexible with your topic access.

How to get an API key

  1. Navigate to the YouScan account of the user who needs the API key.

  2. Go to "My Settings."

  3. Click "Create" in the API key section.

☝️ Remember to copy your key right away, since you cannot view it twice.

How to renew/re-create the API key

  1. Navigate to the YouScan account of the user who needs to re-create the API key.

  2. Go to "My Settings."

  3. Click "Re-create" in the API key section.

Happy monitoring! :)

Send us a chat message if you have any questions about YouScan's API!

Did this answer your question?