Receber menções do projeto

Este método usa parâmetros de filtro como parâmetros de consulta de URL e retorna menções que correspondem a esses filtros.

GET https://api.smelter.ai/v1/mentions/<account_name>/<project_name> — receber menções do projeto.

Exemplo:

https://api.smelter.ai/v1/mentions/myaccount/myproject?docs_per_page=100&newest_post_timestamp=1674147188
&&oldest_post_timestamp=1673253298countries=pt&countries=br

A resposta para esta solicitação retorna no máximo 100 menções, incluindo a data da menção no intervalo de 167325329 a 1674147188, somente para Portugal e Brasil.

Parâmetros de filtragem

Os parâmetros disponíveis estão listados abaixo:

only_main_topic=true — retorna apenas menções relevantes. Se o valor do parâmetro for false também retorna menções brutas.

countries=pt,br — uma lista de países.

languages=por,esp — uma lista de idiomas.

newest_post_timestamp=1674147188&oldest_post_timestamp=1673253298 — restrições de tempo no formato de carimbo de data/hora do UNIX. post_timestamp é um momento em que a menção apareceu na Internet de acordo com nossos dados.

newest_insert_timestamp=1674147188&oldest_insert_timestamp=1673253298 — restrições de tempo no formato de carimbo de data/hora do UNIX. insert_timestamp é um momento em que processamos a adição da menção ao seu projeto.

source_names=twitter.com,facebook.com — retorna menções apenas das fontes. Use nomes de domínio de segundo nível sem http/https.

sentiment=positive,negative — restringe as menções por sentimento. Tipos de sentimento disponíveis: positivo, negativo e neutro. Menções irrelevantes não pode ser analisada pelo sentimento.

search_query=complaint — menções que contêm a palavra "complaint" ("reclamação" ou "queixa") em seu snippet.

tags=mytag1,mytag2 — menções contendo etiquetas.

Filtros rejeita-faixa

Você pode adicionar filtros rejeita-faixa para todos os parâmetros de filtragem, exceto o sentiment.

Por exemplo:

source_names=-twitter.com,-facebook.com — retorna menções para todas as fontes, exceto twitter.com e facebook.com.

Parâmetros de exibição

page_size=100 — restringe o número máximo de menções retornadas a 100 por página.

sort_by=newest_post_timestamp — uma ordem de classificação: da mais recente para a mais antiga (por padrão). Opções disponíveis: newest_post_timestamp, oldest_post_timestamp, newest_insert_timestamp, oldest_insert_timestamp.

Formato da resposta

O método retorna menções no seguinte formato:

{
"data": [
    {
       "title": "Título dos post",
       "url": "https://subdomain.source_name.com/url",
       "source_name": "source_name.com",
       "post_timestamp": 1682521449,
       "insert_timestamp": 1682521459,
       "snippet": "Algum snippet",
       "is_main_topic": true,  # pode ser false
       "language": "por",
       "country": "br",
       "sentiment": "positive",
       "tags": ["minhaetiqueta1", "minhaetiqueta2"],
       "mention_id": "cddeb635593ed4ee00",
    },
    {
    ...
    }
],
"next_page_url": "https://api.smelter.ai/v1/mentions/myaccount/myproject?..." # URL para recuperar a próxima página, se disponível,
"has_next_page": true
}

Paginação

Você pode dividir a resposta em várias páginas, se houver um número suficiente de menções disponíveis.

O parâmetro has_next_page em uma resposta estará ativo.

Além disso, você pode usar o parâmetro next_page_url — ele pode ser usado para recuperar a próxima página.

Códigos de resposta

Boa resposta

A boa resposta tem o seguinte formato:

{
"data": useful_data,
"has_next_page": true # para respostas paginadas,
"next_page": "url" # próxima página, se disponível para respostas paginadas

other fields
}

Resposta ruim

As respostas ruins são códigos 400 e códigos HTTP semelhantes.

{
"error": {
"code": "ChannelNotFound",
"message": "O projeto não existe"
}
}

Erros

Os possíveis erros estão listados abaixo:

— ChannelNotFound — projeto não encontrado.

— AccountNotFound — conta não encontrada.

— MentionNotFound — menção não encontrada.

— ValidationError — o JSON tem campos incorretos.

— TagNotFound — a etiqueta do filtro não foi encontrada.