FAQs - API e Integrações STILINGUE 12 de dezembro de 2023 14:39 Atualizado Índice: Qual a fonte das informações sobre equivalência publicitária? A STILINGUE disponibiliza a API para o Radar ou apenas para as áreas do painel? Como consigo obter os dados da Operação do STILINGUE Smart Care pela API da Stilingue? Como é calculado a métrica de alcance no endpoint de métricas proprietárias? Como filtrar os dados na API Stilingue (por data, interação, filtro de Conversas)? Como funciona a ativação das integrações com bots? Como funciona a pontuação do gráfico de Destaques? Como funciona o parâmetro last_days? Como poderei ter acesso aos clippings coletados na minha pesquisa? Como posso integrar a API STILINGUE com outras ferramentas para visualização de dados, como o Google DataStudio e o Microsoft PowerBI, por exemplo? Devido à conformidade com a Lei Geral de Proteção de Dados, quais as mudanças na API STILINGUE? É possível integrar a API STILINGUE com alguma ferramenta? É possível negativar filtros assim como é feito no filtro global da ferramenta? É possível obter os textos das publicações via API de Listening? É possível ter acesso aos áudios e vídeos de clippings coletados de rádio ou televisão? Existe um limite para o número de requisições que podem ser feitas na API STILINGUE? Minha empresa possui o serviço de uma clipadora diferente às que a STILINGUE trabalha atualmente, posso coletar essas publicações na minha pesquisa? Minha pesquisa coletará somente os clippings offline ou também inclui o conteúdo online? Não consigo acessar os dados da API, dando erro 404, qual o motivo? O parâmetro page_id pode retornar valor nulo em Interação Proprietária de Instagram? O que acontece se não colocar um intervalo de datas na requisição? O que é e como funciona a coleta de Clipping? O que pode ocasionar a não liberação do token de acesso? Onde posso encontrar mais informações sobre as APIs externas utilizadas pela STILINGUE? Os dados da API não estão batendo com o da ferramenta, qual o motivo? Por que algumas imagens de publicações coletadas na STILINGUE expiram após algum tempo? É possível recuperar o link da imagem original? Por que um mesmo parâmetro (por exemplo location) às vezes vem vazio ("") e às vezes vem como null? Porque algumas métricas são entregues em alguns clippings e em outros não? Quais campos são entregues e quais não são entregues na API STILINGUE para cada rede? Quais campos são possíveis de serem filtrados? Qual a finalidade dos operadores na configuração de pesquisa? Qual a fonte das informações sobre equivalência publicitária? Todas as informações de equivalência publicitária - centimetragem, minutagem, valor em dinheiro, etc. - são entregues pelas clipadoras. Os desenvolvedores da STILINGUE não têm acesso ao cálculo realizado. A nossa área de resumo possibilita reunir estas informações para ajudar nos insights de seus clippings. A STILINGUE disponibiliza a API para o Radar ou apenas para as áreas do painel? A API só retorna dados de Listening (Filtro de Publicações e de Conversas), Métricas Proprietárias e Smart Care, ou seja: não disponibilizamos a API para o Radar. Como consigo obter os dados da Operação do STILINGUE Smart Care pela API da Stilingue? Os dados da operação podem ser obtidos através da API de exportação do STILINGUE Smart Care. API de relatório do STILINGUE Smart Care: Tempo que a pessoa que faz o atendimento ficou com o post em tratativa: pode ser encontrado no campo de mudança de status, filtrando pelas mudanças de status que estavam em pendente: Tempo que a pessoa que faz o atendimento levou para encerrar o atendimento do post (campo de conversas): é mostrado o tempo que levou para o fechamento: Data e hora que o post foi aberto (campo de conversas): em initAt é encontrado o momento que a primeira conversa se iniciou: Data e hora que o post foi finalizado (campo de conversas): em endAt: Data e hora que o post foi reaberto; Para a Reabertura dos posts, não há nativamente esse tratamento na ferramenta, para isso a API entrega uma área “cases” calculada em tempo de execução e sempre que uma conversa sai do status fechado para pendente ou aberto, é criado um objeto contendo o id dessa conversa com um _n no final, representando o número de reaberturas daquela conversa, lá é possível encontrar a hora de foi reaberto e "refechado". Como é calculado a métrica de alcance no endpoint de métricas proprietárias? Esse valor de reach -> total corresponde à média do alcance das publicações. Nesse caso, publicação pode ser story, post ou dark post. Como filtrar os dados na API STILINGUE (por data, interação, filtro de Conversas)? Os filtros aceitos na API Stilingue são os mesmos presentes no filtro global do sistema, tanto para o filtro de publicações quanto para o de conversas. O uso deles pode ser feito por parâmetros enviados no corpo da requisição da API ou na própria URL, o nome dos filtros se encontram na documentação. Para adicionar os filtros na URL, basta incluir o nome e o valor seguido de um “?” no final da URL, se for necessário mais de um filtro, incluir após um “&”, por exemplo: api.stilingue.com.br/wrapi/visao_geral/<TOKEN>?date_range=30d&sentiment=1 Como funciona a ativação das integrações com bots? Para integrar a API STILINGUE com chatbots, entre em contato com o seu Gerente de Sucesso e faça o pedido. A STILINGUE irá se reunir com o time desenvolvedor do bot para solicitar a integração, incluindo uma URL da API no bot que realiza a conexão desejada - para remover mensagens de conversa ou adicionar tags em mensagens, por exemplo. Como funciona a pontuação do gráfico de Destaques? Dada a coleta de uma notícia pelo match de um ou mais descritores configurados no Editor de Pesquisa, a pontuação representa a relevância destes descritores conforme a localização das palavras-chave na notícia, conforme os seguintes pesos: Título: Peso 5 Texto (corpo da notícia): Peso 3 Legenda das imagens: peso 1 A pontuação final é a soma destes pesos entre as notícias coletadas no período Observação: Nosso provedor de notícias pode identificar se houve algum destaque no texto ou no título, e esta pontuação também é considerada mesmo na ausência de operadores cadastrados na Configuração de Pesquisa. Como funciona o parâmetro last_days? O parâmetro last_days retorna dados referente a 1 dia, considerando o número de dias anteriores à data da requisição. Exemplo: last_days= 3 No caso, só serão retornados os dados do dia em questão, contando 3 dias anteriores a hoje. Então, se faço uma requisição no dia 23/05 por last_days= 3, será retornado somente os dados do dia 20/05. Como poderei ter acesso aos clippings coletados na minha pesquisa? Você poderá encontrar todos os clippings coletados na área de Imprensa para acessar os gráficos de resumo dos dados e classificações da coleta. Seus clippings estarão disponíveis também como cards no nosso Mural de Publicações. Como posso integrar a API STILINGUE com outras ferramentas para visualização de dados, como o Google DataStudio e o Microsoft PowerBI, por exemplo? Para integrar a API STILINGUE a outras plataformas, é solicitar o token de acesso ao seu Gerente de contas. Depois, para a conexão, utilizaremos um token de teste com limite de 400 publicações do mural de publicações nos últimos 3 dias para ter acesso à requisição: api.stilingue.com.br/wrapi/publicacoes/ <TOKEN> (substitua o <TOKEN> pelo número do seu token. Por último, é só conectar a plataforma desejada. Serviços Personalizados: precisa de ajuda para construir e gerir plataformas de análises de dados? Podemos te ajudar! Nosso time de especialistas está pronto para te atender. Entre em contato com o seu gerente de contas STILINGUE para ter acesso a esse e vários outros serviços. Devido à conformidade com a Lei Geral de Proteção de Dados, quais as mudanças na API STILINGUE? As principais mudanças são na API e na integração de outras ferramentas. Dados pessoais dos usuários, como nome, imagem, texto entre outras que são exclusivas do usuário - com exceção do ID - não serão mais acessadas pela API. O acesso a esses dados poderá ser feito apenas com a API de cada rede. Para gerar o token de acesso é necessário solicitar ao seu Gerente de Contas. Então, o seu Gerente de Contas o enviará um formulário de conformidade que deverá ser devidamente preenchido e em seguida o nosso time de suporte o enviará o token dentro de 3 dias úteis. Se tiver alguma dúvida sobre a LGPD, nosso departamento Jurídico está à disposição. Entre em contato com a gente através do e-mail: juridico@stilingue.com.br. É possível integrar a API STILINGUE com alguma ferramenta? Sim. Ferramentas que aceitam receber dados de APIs podem se integrar com a API STILINGUE, para isso, é necessário que um time técnico faça a integração. Para as ferramentas mais comuns existe um tutorial na Central de Ajuda: Google Sheets Power BI Data Studio Para integrar com Data Studio e Google Sheets é necessário utilizar um conector de terceiros chamado Supermetrics, também é possível gerar planilhas a partir da API usando o Google Apps Script. Observação: a integração só é feita de dados internos da STILINGUE para as outras ferramentas. O caminho contrário (integração de dados de terceiro para STILINGUE) não é permitido. É possível negativar filtros assim como é feito no filtro global da ferramenta? Sim, na API a negativação é feita pelo sinal de menos “-”. Os campos que podem ser negativados são os mesmos da ferramenta. Exemplo negativação do canal Instagram na chamada; Exemplo negativação de um id de usuário. É possível obter os textos das publicações via API de Listening? Não entregamos estes dados devido a questões de compliance e LGPD com as redes sociais. É possível ter acesso aos áudios e vídeos de clippings coletados de rádio ou televisão? É sim. Ao clicar em “Ler Publicação Completa” no seu card de publicação e lá você encontrará o texto, vídeo ou áudio na íntegra, juntamente à sua transcrição e informações detalhadas. Existe um limite para o número de requisições que podem ser feitas na API STILINGUE? Atualmente não temos um limite no número de requisições que podem ser feitas pela API STILINGUE, no entanto, permitimos que apenas uma requisição seja executada por vez. Minha empresa possui o serviço de uma clipadora diferente às que a STILINGUE trabalha atualmente, posso coletar essas publicações na minha pesquisa? Pode sim. Entre em contato com o seu Gerente de Contas para contratar o serviço e o informe sobre sua clipadora. Depois siga o mesmo processo de encaminhamento de e-mails e nosso time de serviços certificará que seus clippings sejam coletados. Minha pesquisa coletará somente os clippings offline ou também inclui o conteúdo online? Ao adquirir o painel STILINGUE, sua pesquisa já é contemplada com portais como canais de coleta. Ao ativar o serviço de clipping, sua pesquisa coletará também dos canais offline disponíveis. São eles: Rádio, TV, Impresso, entre outros. Não consigo acessar os dados da API, dando erro 404, qual o motivo? Este erro ocorre quando o token do cliente não consta no código da API, isso pode ocorrer quando: Cliente está digitando o token errado; Token não foi atualizado no código. O parâmetro page_id pode retornar valor nulo em Interação Proprietária de Instagram? Quando o post de Instagram é do tipo carrossel, o page_id pode vir como nulo. O cliente poderá utilizar o parâmetro “uid” para verificar o ID da página que realizou a publicação. O que acontece se não colocar um intervalo de datas na requisição? Sempre que o cliente não colocar intervalo de datas na requisição o retorno da API considerará o dia atual a partir das zero horas (00h:00). O que é e como funciona a coleta de Clipping? Clippings são menções de uma determinada marca na mídia aberta (televisão, portais, imprensa, revistas, rádio, por exemplo). Assim, é possível integrar novas fontes externas de dados, fazer análises cada vez mais completas e obter insights ainda mais robustos dentro da plataforma STILINGUE. Para coletar e monitorar clippings é necessário ter os serviços das clipadoras Fábrica de Ideias ou Clipping Service e entrar em contato com o seu Gerente de Contas para ativar a funcionalidade. Para integrar os dados da clipadora é necessário indicar os operadores na sua Configuração de Pesquisa e então realizar a integração. O que pode ocasionar a não liberação do token de acesso? Ter a liberação do token negada é muito raro. Caso um caso seja critico seu Gerente de Contas tratará em paralelo juntamente à equipe de compliance. Normalmente o token não é liberado para monitoramento politico. Onde posso encontrar mais informações sobre as APIs externas utilizadas pela STILINGUE? Você pode consultar a documentação referente a APIs disponibilizada por cada rede social, sendo que a atualização desses conteúdos é de responsabilidade das redes citadas. Confira abaixo os links para as APIs de cada rede: Facebook Instagram Linkedin Twitter Youtube Os dados da API não estão batendo com o da ferramenta, qual o motivo? A API puxa os mesmos dados da ferramenta, quando existe alguma diferença, o motivo é o filtro usado na ferramenta e na API. Caso esteja ocorrendo divergência nos dados, verifique o filtro de data (date_range): basta bater o filtro de data e que estiver na URL da API junto com o que estiver na URL da ferramenta. Por padrão, o intervalo de data da API é 1 dia. Dica: Para facilitar, é possível utilizar o parâmetro “filters” encontrado na própria ferramenta, e utilizá-lo na API. Os únicos parâmetros que funcionam junto com o “filters”, são “date_range”, “limit” e “order_by”. Caso tenha algum parâmetro que não seja esses 3 junto ao “filters”, a requisição não irá funcionar. Por que algumas imagens de publicações coletadas na STILINGUE expiram após algum tempo? É possível recuperar o link da imagem original? No caso de publicações do Facebook, Twitter e Instagram os links das imagens referentes a publicações coletadas podem expirar após algumas semanas por definição da rede. Essa situação pode ocorrer em diferentes áreas da plataforma, como Listening ou Métricas Proprietárias. Quando isso acontece, a imagem coletada na STILINGUE também fica indisponível e não pode ser atualizada na plataforma. Se você deseja recuperar a URL original, será necessário buscá-la manualmente na rede social de origem. Por que um mesmo parâmetro (por exemplo location) às vezes vem vazio ("") e às vezes vem como null? Isso significa que os dados de localização não estão disponíveis. De maneira mais técnica, temos: Aspas duplas sem nada dentro: indica que o campo é vazio e não possui informação (usuário não compartilhou dados de geolocalização). O null indica um valor inválido ou desidratado (por exemplo: a API não entrega esse valor. Desidratado é quando removemos eles por questões de compliance com os termos da Rede Social, pois conflita com a LGPD) Também pode ter variação de redes sociais, uma rede pode entregar o valor de geolocalização vazio enquanto outras podem nem entregar esse dado. Como esse parâmetro está sempre disponível na resposta da nossa API (por padrão mostramos todos os campos), ele virá como null quando a rede social não o entregar. Porque algumas métricas são entregues em alguns clippings e em outros não? Quando algumas métricas estão em falta é porque a própria clipadora não entregou a métrica do clipping. Em algumas ocasiões, percebemos também uma entrega equivocada do dia e horário da publicação do clipping. Entre em contato com nossa equipe de Atendimento ao Cliente no chat e eles poderão confirmar a situação. Se Confirmado, você será orientado a contatar a clipadora para informar a ausência ou equívoco de dados, nesse caso, ficará a seu critério. Quais campos são entregues e quais não são entregues na API STILINGUE para cada rede? Atualmente temos documentado sobre a API STILINGUE: Parâmetros obrigatórios e opcionais de entrada Limitações Requerimento de autenticação Métodos aceitos Valor recebido A API STILINGUE é disponibilizada para os produtos Listening, Métricas Proprietárias e STILINGUE Smart Care. Quais campos são possíveis de serem filtrados? É possível filtrar pelos mesmos campos disponíveis no filtro da ferramenta. Qual a finalidade dos operadores na configuração de pesquisa? Assim que o link dos clippings forem enviados para o nosso e-mail de coleta, a funcionalidade já estará habilitada. No entanto, é necessário que você acrescente os operadores “integracao:Fábrica de Ideias” ou “integracao:Clipping Service” nos Grupos de sua preferência, para que o conteúdo seja integrado à Configuração de Pesquisa. Dessa forma, você poderá classificar as publicações coletadas e escolher os canais de coleta desejados. Para mais informações, acesse a discussão sobre o assunto em nossa comunidade ou os vídeos no nosso canal. 😃 Artigos relacionados Como definir um tempo limite (timeout) para ações do Builder Google Sheets - Integrações com a API STILINGUE Ação: Requisição HTTP Radar Insights - Listening FAQs - Smart Care