FAQs - STILINGUE API and Integrations – Blip | Blip Help

Index:

What is the source of information about advertising equivalency?

All advertising equivalency information - centimeters, minutes, monetary value, etc. - is provided by clipping agencies. STILINGUE developers do not have access to the calculation performed. Our summary area allows you to gather this information to assist in the insights of your clippings.

Does STILINGUE provide the API for both the Radar and the dashboard areas?

The API only returns data for Listening (Publication and Conversation Filters), Proprietary Metrics, and Smart Care. In other words, we do not provide the API for the Radar.

How do I obtain STILINGUE Smart Care operation data through the Stilingue API?

The operation data can be obtained through the STILINGUE Smart Care export API.

STILINGUE Smart Care Reporting API:

Time the person handling the post spent in treatment: can be found in the status change field, filtering by status changes that were pending:

Time the person handling the post took to finish the conversation (conversation field): it shows the time it took to close:

Date and time the post was opened (conversation field): initAt contains the moment the first conversation started:

Date and time the post was completed (conversation field): in endAt:

Date and time the post was reopened;
For post reopening, there is no native handling in the tool, so the API provides a runtime-calculated 'cases' area, and whenever a conversation transitions from closed to pending or open status, an object is created containing the ID of that conversation with an '_n' at the end, representing the number of times that conversation was reopened. There you can find the time it was reopened and 're-closed'.

How is the reach metric calculated in the proprietary metrics endpoint?

This reach value -> total corresponds to the average reach of the posts. In this case, a post can be a story, a regular post, or a dark post.

How to filter data in the STILINGUE API (by date, interaction, conversation filter)?

The filters accepted in the Stilingue API are the same as those present in the system's global filter, both for post filtering and conversation filtering.

They can be used by parameters sent in the API request body or in the URL itself; the filter names are found in the documentation.

To add filters to the URL, simply include the name and value followed by a "?" at the end of the URL; if more than one filter is needed, include "&" after it, for example:

api.stilingue.com.br/wrapi/visao_geral/<TOKEN>?date_range=30d&sentiment=1

How does the activation of integrations with bots work?

To integrate the STILINGUE API with chatbots, please get in touch with your Success Manager and make the request. STILINGUE will meet with the bot's development team to request the integration, including an API URL in the bot that facilitates the desired connection - such as removing chat messages or adding tags to messages, for example.

How does the Highlights Chart scoring work?

Given the collection of a news article through matching one or more descriptors configured in the Research Editor, the score represents the relevance of these descriptors based on the location of keywords in the news, according to the following weights:

Title: Weight 5
Text (body of the news): Weight 3
Image captions: Weight 1
The final score is the sum of these weights among the news collected in the period.

Note: Our news provider can identify if there were any highlights in the text or title, and this score is also considered even in the absence of operators registered in the Research Configuration.

How does the last_days parameter work?

The parameter last_days returns data for 1 day, considering the number of days before the request date.

Example:

last_days= 3

In this case, only data from the current day and the previous 3 days will be returned. So, if I make a request on 23/05 with last_days=3, it will only return data from 20/05.The final score is the sum of these weights among the news collected during the period.

How can I access the clippings collected in my research?

You can find all the clippings collected in the Press section to access summary graphs of the data and collection classifications. Your clippings will also be available as cards on our Publication Wall.

How can I integrate the STILINGUE API with other data visualization tools like Google DataStudio and Microsoft PowerBI, for example?

To integrate the STILINGUE API with other platforms, you need to request the access token from your Account Manager. Next, for the connection, we'll use a test token with a limit of 400 posts from the publication wall in the last 3 days to access the request: api.stilingue.com.br/wrapi/publicacoes/ <TOKEN> (replace <TOKEN> with your token number). Finally, you can connect to the desired platform.

Customized Services: Need help building and managing data analytics platforms? 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.

Due to compliance with the General Data Protection Law, what are the changes in the STILINGUE API?

The main changes are in the API and the integration of other tools. User's personal data, such as name, image, text, and others that are unique to the user - except for the ID - will no longer be accessed through the API. Access to this data can only be done through each network's API. To generate the access token, you need to request it from your Account Manager. Then, your Account Manager will send you a compliance form that should be duly filled out, and our support team will send you the token within 3 business days.

If you have any questions about LGPD, our Legal department is available. Contact us via email: juridico@stilingue.com.br.

Is it possible to integrate the STILINGUE API with any tools?

Yes. Tools that accept receiving data from APIs can integrate with the STILINGUE API, and for this, it's necessary for a technical team to handle the integration.

For the most common tools, there is a tutorial available in the Help Center:

Google Sheets
Power BI
Data Studio

To integrate with Data Studio and Google Sheets, it's necessary to use a third-party connector called Supermetrics. It's also possible to generate spreadsheets from the API using Google Apps Script.

Note: The integration is only done from STILINGUE's internal data to other tools. The reverse path (integration of third-party data to STILINGUE) is not allowed.

Can I negate filters similar to how it's done in the tool's global filter?

Yes, in the API, negation is done using the minus sign “-”. The fields that can be negated are the same as those in the tool.

Example negation of the Instagram channel in the query;
Example negation of a user ID.

Is it possible to retrieve the text of publications via the Listening API?

We do not provide this data due to compliance and LGPD issues with social media platforms.

Can I access the audio and video clips collected from radio or television?

Yes. By clicking on 'Read Full Publication' in your publication card, you will find the full text, video, or audio along with its transcription and detailed information.

Is there a limit to the number of requests that can be made in the STILINGUE API?

Currently, we do not have a limit on the number of requests that can be made through the STILINGUE API; however, we allow only one request to be executed at a time.

My company uses a different clipping service than the ones STILINGUE currently works with. Can I collect these publications in my research?

Yes, you can. Please get in touch with your Account Manager to arrange for the service and inform them about your clipping agency. Then, follow the same email forwarding process, and our service team will ensure that your clippings are collected.

Will my research collect only offline clippings, or does it also include online content?

When you acquire the STILINGUE dashboard, your research is already covered with portals as collection channels. By activating the clipping service, your research will also collect from offline channels available. These include Radio, TV, Print, among others.

I can't access the API data, it's giving a 404 error, what's the reason?

This error occurs when the client's token is not present in the API code. This can happen when:

The client is typing the token incorrectly;
The token has not been updated in the code.

Can the page_id parameter return null value in Instagram Owner Interaction?

When an Instagram post is of the carousel type, the page_id can be null.

The client can use the 'uid' parameter to check the ID of the page that made the post.

What happens if I don't include a date range in the request?

When the client does not specify a date range in the request, the API response will consider the current day starting from midnight (00h:00).

What is and how does the Clipping collection work?

Clippings are mentions of a particular brand in open media (television, portals, press, magazines, radio, for example). This way, it's possible to integrate new external sources of data, conduct increasingly comprehensive analyses, and gain even more robust insights within the STILINGUE platform.

To collect and monitor clippings, you need to have the services of clipping agencies Idea Factory or Clipping Service and get in touch with your Account Manager to activate the feature.

To integrate the data from the clipping agency, you need to specify the operators in your Research Configuration and then proceed with the integration.

What can result in the non-release of the access token?

Having the token denied is very rare. If a case is critical, your Account Manager will handle it in parallel with the compliance team. Usually, the token is not released for political monitoring.

Where can I find more information about the external APIs used by STILINGUE?

You can consult the documentation related to APIs provided by each social network, and the updating of these contents is the responsibility of the mentioned networks.

Check out the links to the APIs of each network below:

The API data doesn't match the tool's data, what could be the reason?

The API pulls the same data as the tool; when there's any difference, it's due to the filter used in the tool and the API.

If there's a discrepancy in the data, check the date filter (date_range): make sure the date filter matches what's in the API URL along with what's in the tool's URL. By default, the API's date range is 1 day.

Tip: To simplify, you can use the "filters" parameter found in the tool itself and apply it to the API.

The only parameters that work alongside "filters" are "date_range," "limit," and "order_by." If there's any parameter other than these 3 along with "filters," the request won't work.

Why do some images of publications collected in STILINGUE expire after some time? Is it possible to retrieve the link to the original image?

In the case of Facebook, Twitter, and Instagram posts, the links to images associated with collected posts may expire after a few weeks as defined by the network. This situation can occur in different areas of the platform, such as Listening or Proprietary Metrics.

When this happens, the collected image in STILINGUE also becomes unavailable and cannot be updated in the platform. If you want to retrieve the original URL, you will need to search for it manually on the original social network.

Why does the same parameter (e.g., location) sometimes come as empty ("") and other times as null?

This means that location data is not available.

In a more technical sense, we have:

Double quotes with nothing inside: indicate that the field is empty and contains no information (the user did not share geolocation data).
Null indicates an invalid or dehydrated value (for example: the API does not provide this value. Dehydrated means when we remove them for compliance with the terms of the Social Network, as it conflicts with LGPD)

There can also be variations among social networks; one network may provide empty geolocation value while others may not provide this data at all. As this parameter is always available in our API response (we show all fields by default), it will come as null when the social network does not provide it.

Why are some metrics delivered in some clippings and not in others?

When some metrics are missing, it's because the clipping agency didn't provide the clipping metric. On some occasions, we also notice incorrect delivery of the publication date and time for the clipping.

Please contact our Customer Support team via chat, and they will be able to confirm the situation. If confirmed, you will be instructed to contact the clipping agency to report the absence or data error, in which case, it will be at your discretion.

Which fields are delivered and which are not delivered in the STILINGUE API for each network?

Currently, we have documented about the STILINGUE API:

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.

Which fields can be filtered?

It is possible to filter by the same fields available in the tool's filter.

What is the purpose of operators in research configuration?

As soon as the links of the clippings are sent to our collection email, the functionality will already be enabled. However, it's necessary for you to add the operators 'integration: Idea Factory' or 'integration: Clipping Service' to the Groups of your preference so that the content is integrated into the Research Configuration. This way, you can classify the collected publications and choose the desired collection channels.

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

Related articles