Reputação e estudos

Relatórios de análise multimodelo: a pontuação mensal da reputação da sua marca face à dos concorrentes e os estudos de IA personalizados que define sobre quaisquer temas e dimensões. As pontuações são calculadas de forma independente por vários modelos de análise, pelo que deve comparar os modelos em vez de calcular uma média sem os distinguir. Requer monitorização de reputação na conta.

GET/reputation/reports

Os relatórios mensais de reputação de um projeto, do mais recente para o mais antigo. Os relatórios pendentes e falhados são incluídos de propósito, uma vez que a questão mais frequente é saber se este mês chegou a ser executado. Cada linha inclui o id do relatório, o respetivo estado e quais os modelos analistas que produziram dados.

Parâmetros:
  • project_idobrigatório
  • page
  • per_page
  • output

GET/reputation/reports/:id

Um relatório devolve pontuações em linhas planas: uma linha por modelo de análise, marca, dimensão e atributo, com a pontuação de 0 a 100 e a justificação apresentada pelo modelo. Um model desconhecido devolve ERR_INVALID_PARAM em vez de uma lista vazia, e brand exige correspondência exata, sem aceitar correspondências parciais.

Parâmetros:
  • project_idobrigatório
  • :idid do relatório
  • model
  • brandnome ou lista separada por vírgulas
  • dimension
  • page
  • per_page
  • output

GET/studies

Os estudos de IA personalizados definidos na conta. Os estudos pertencem à conta e não a um projeto, pelo que project_id é aqui um filtro opcional e os estudos ao nível da conta são devolvidos independentemente do projeto pelo qual filtra.

Parâmetros:
  • project_idopcional
  • statusactive|archived
  • page
  • per_page
  • output

GET/studies/:id

Um estudo com o respetivo briefing, os sujeitos que compara, as dimensões em que os avalia e o histórico de relatórios. Utilize os ids em reports com o endpoint abaixo indicado.

Parâmetros:
  • :idid do estudo

GET/studies/:id/reports/:report_id

As pontuações de um relatório de estudo personalizado em linhas planas, com o mesmo formato das pontuações dos relatórios de reputação: uma linha por modelo analista, sujeito, dimensão e atributo.

Parâmetros:
  • :idid do estudo
  • :report_id
  • model
  • subjectnome ou lista separada por vírgulas
  • dimension
  • page
  • per_page
  • output

POST/reputation/reports

Inicia o relatório de reputação deste mês, tal como o botão Gerar relatório de reputação na página de Reputação, e responde 201 com o novo relatório. Se o mês já tiver um relatório que não tenha falhado, quer esteja em execução quer concluído, não é iniciado nada de novo e a resposta é 200 com created false e esse relatório. recalculate true usa o único recálculo manual do mês para uma nova execução com todos os modelos analistas; quando o mês já tem dois relatórios, devolve ERR_LIMIT_REACHED. Consulte periodicamente GET /reputation/reports até o relatório estar concluído. Requer uma chave com âmbito read_write.

Corpo:
  • project_idobrigatório
  • recalculatebooleano, false por predefinição