Skip to main content

Documentation Listening - STILINGUE API

  • Updated

Index:

  1. Introduction
  2. Documentation of Listening
  3. How is the documentation presented, and how are the data presented to the programmer?

 

Introduction

The API documentation is technical content with information on how to use and effectively integrate with another API, which enables greater autonomy in adopting the functionality.

Custom Services:  Need help with importing structured data? We can assist you! Our team of experts is ready to assist you. Contact your STILINGUE account manager to gain access to this and many other services.

For more information about the STILINGUE API (what it is, how it works, and how to acquire it), check out our guide.

Our documentation is regularly updated and currently covers the following areas:

  • Required and Optional Input Parameters;
  • Limitations:
  • Authentication Requirement:
  • Accepted Methods:
  • Received Value;

The STILINGUE API is available for the Listening, Proprietary Metrics, and STILINGUE Smart Care products. Check below for extracted data, limitations, and potential solutions by product:

 

Documentation of Listening:

It is possible to extract data from almost all areas of the Listening menu, such as: Post Wall, AAA Influence Ranking, Where They're Talking, Themes and Topics, and Overview.
The data limitations of the Listening documentation are as follows:

 

*Due to social media compliance measures, some publication data needs to be dehydrated and removed.Access the complete Listening documentation via the link: 

Within each developer documentation, we explain the root, the endpoint (URL where the service can be accessed) for starting the "lego assembly," a dictionary that aids in understanding each code, the limitations and protocols of our API, and the necessary requests.


How is the documentation presented and how are the data presented to the programmer?

 

Here we have the root, the endpoint (URL where the service can be accessed), and other information, as explained above.

  • What are the restrictions of the STILINGUE API? In the requests sent, it's only possible to make one request at a time; requests can take up to 60 seconds to be sent, for example, when the date range is very long or when many posts are requested. If this time is exceeded, you should try again. When reconnection is necessary, the following notification will appear:

After acquiring the access token, click here to check how to request the token, and the next step is to open the documentation. With the provided information, simply start the project:

 

Within the navigation bar, we first enter the root, followed by the information provided in the documentation (in the case of the example above, the publication information), as indicated by the arrow. Next, we insert the access token.
Ex: 

 

Green: Endpoint (root)

Pink: Request for publications

Yellow: Token 

Blue: Filter for the 50 publications from the last 7 days

The API data will be displayed as follows: 

 

 

When the fields have a null value, it can be either dehydrated data or data that the social network does not provide.
For example, "reaction_thankful" on YouTube will come as null because it's not data that YouTube possesses, as we can see in the image below: 

 

 

For more information, visit the discussion on the subject at our community or videos on our channel. 😃

 

Related articles