Skip to main content

Documentation Proprietary Metrics - STILINGUE API

  • Updated

Index:

  1. Introduction
  2. Documentation of Proprietary Metrics
  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 access this and several 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 products Listening, Proprietary Metrics and STILINGUE Smart Care. Check below for extracted data, limitations, and potential solutions by product:

 

Documentation of Proprietary Metrics: 

Just like in Listening, here you can also acquire data from almost all areas, according to the side menu of each social network. On Facebook, for example, there are options:  Overview, Most Engaged Users, Facebook Insights, Post Analysis, Comment Analysis, and Fanpage Comparison. 

Below are the limitations of the documentation:

Area Limitations Contour solutions
1) Facebook Enabled Posts  
  Posts Posts, All Comments, Inbox, and Visitor Posts can be found in the Listening API (using the fanpages parameter)
  All comments
  Inbox
  Reviews
  Visitor Posts
2) Twitter Posts VS. Interactions  
  Posts Posts, All Comments, Direct Messages, and Mentions can be found in the Listening API (using the Conversations filter, using the fanpages parameter)
  All comments
  Direct messages
  Mentions
  URL Content: "post_url", "user_image_url", "user_url", "post_user_image_url Using the tweet ID, you can retrieve information through Twitter's own API: https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/get-statuses-show-id.html
3) Youtube Posts These data can be found in the Listening API (using the Conversations filter)
  All comments
4) Instagram Posts These data can be found in the Listening API (using the Conversations filter)
  All comments

 

Access the complete Proprietary Metrics 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, 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 obtaining the access token, 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. 

Example:

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: 

 

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

Related articles