Getting API access
API data access is available as a paid add-on. Please contact your Customer Success Manager or email us at support@youscan.io. Our team will share pricing options and help you understand how API access can support your goals.
Once API access is enabled, you can generate an API Key by following the steps below.
👉 Please refer to our API Documentation: https://youscan.docs.apiary.io/ to learn what types of data are available through the API.
Create an API Key
Navigate to the YouScan account of the user who needs the API key.
Go to "My Settings."
Click "Create" in the API key section.
☝️ Remember to copy your key right away, since you cannot view it twice.
How to re-create an API key?
Go to "My Settings."
Click "Re-create" in the API key section.
Limit access to certain topics
The API key is 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.
‼️ Sources limitations
Data from the following sources is not available through the API:
Reddit (exporting this data through alternative channels is also restricted)
Quora
Certain smaller sources
Please note that access to mentions collected from Twitter is limited through the API. The following restrictions apply:
Mention's Text and Full Text properties are removed
Mention URL is removed
Author URL, Author Name, and Author AvatarUrl are 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 the Tweet
Combining Profile ID and Post ID lets you navigate to the exact Tweet that corresponds to the collected mention.
--
For any questions or issues relating to APIs or the API documentation, please contact our Support team via our dedicated email address: support@youscan.io