Obtener menciones del proyecto
Este método toma los parámetros del filtro como los parámetros de consulta de URL y devuelve las menciones que coinciden con esos filtros.
GET https://api.smelter.ai/v1/mentions/<account_name>/<project_name>
— obtiene las menciones del proyecto.
Ejemplo:
https://api.smelter.ai/v1/mentions/myaccount/myproject?docs_per_page=100&newest_post_timestamp=1674147188
&&oldest_post_timestamp=1673253298countries=pt&countries=br
La respuesta a esta solicitud devuelve un máximo de 100 menciones, incluida la fecha de la mención en el intervalo de 167325329 a 1674147188, sólo para Portugal y Brasil.
Parámetros del filtrado
A continuación se enumeran los parámetros disponibles:
only_main_topic=true
— devuelve sólo las menciones relevantes. Si el valor del parámetro es false
también devuelve las menciones sin procesar.
countries=pt,br
— una lista de países.
languages=por,esp
— una lista de idiomas.
newest_post_timestamp=1674147188&oldest_post_timestamp=1673253298
— las restricciones del tiempo en el formato del sello del tiempo UNIX. post_timestamp
es el momento en que la mención apareció en Internet según nuestros datos.
newest_insert_timestamp=1674147188&oldest_insert_timestamp=1673253298
— las restricciones del tiempo en el formato del sello de tiempo UNIX. insert_timestamp
es un momento, cuando procesamos la adición de la mención a su proyecto.
source_names=twitter.com,facebook.com
— devuelve las menciones sólo de esas fuentes. Use los nombres del dominio de segundo nivel sin http/https
.
sentiment=positive,negative
— restringe las menciones por el sentimiento. Tipos del sentimiento disponibles: positivo, negativo y neutro. Las [Menciones irrelevantes]( *irrelevante) no se puede analizar por el sentimiento.
search_query=complaint
— las menciones que contienen la palabra "queja" en su fragmento del código.
tags=mytag1,mytag2
— las menciones que contienen las etiquetas.
Filtros negativos
Puede agregar los filtros negativos a todos los parámetros del filtrado excepto al sentiment
.
Por ejemplo:
source_names=-twitter.com,-facebook.com
— devuelve las menciones para todas las fuentes excepto twitter.com y facebook.com.
Parámetros de visualización
page_size=100
— restringe el número máximo de las menciones devueltas a 100 por página.
sort_by=newest_post_timestamp
— un orden de la clasificación: del más reciente al más antiguo (por defecto). Las opciones disponibles: newest_post_timestamp
, oldest_post_timestamp
, newest_insert_timestamp
, oldest_insert_timestamp
.
Formato de la respuesta
El método devuelve las menciones en el siguiente formato:
{
"data": [
{
"title": "Título del mensaje",
"url": "https://subdomain.source_name.com/url",
"source_name": "fuente_nombre.com",
"post_timestamp": 1682521449,
"insert_timestamp": 1682521459,
"snippet": "Algún fragmento del código",
"is_main_topic": true, # puede ser falso
"language": "esp",
"country": "mx",
"sentiment": "positivo",
"tags": ["mietiqueta1", "mietiqueta2"],
"mention_id": "cddeb635593ed4ee00",
},
{
...
}
],
"next_page_url": "https://api.smelter.ai/v1/mentions/myaccount/myproject?..." # url para recuperar la página siguiente si está disponible,
"has_next_page": true
}
Paginación
Puede dividir la respuesta en varias páginas, si hay suficientes menciones disponibles.
El parámetro has_next_page
en una respuesta estará activo.
También puede usar el parámetro next_page_url
— se puede utilizar para recuperar la página siguiente.
Información
No cambie las restricciones sort_by
de los parámetros y sellos del tiempo durante la paginación.
Códigos de la respuesta
Buena respuesta
Las buenas respuestas tiene el siguiente formato:
{
"data": useful_data,
"has_next_page": true # para respuestas paginadas,
"next_page": "url" # página siguiente si está disponible para respuestas paginadas
otros campos
}
Mala respuesta
Las malas respuestas son código 400
y códigos HTTP similares.
{
"error": {
"code": "ChannelNotFound",
"message": "El proyecto no existe"
}
}
Errores
A continuación se enumeran los posibles errores:
— ChannelNotFound — el proyecto no encontrado.
— AccountNotFound — la cuenta no encontrada.
— MentionNotFound — la mención no encontrada.
— ValidationError — JSON tiene campos incorrectos.
— TagNotFound — no se encuentra la etiqueta del filtro.
El formato del sello del tiempo UNIX
se muestra con only_main_topic=false