-
Customer Experience -
Employee Experience -
Brand Experience -
Core XM -
Design XM
Monitoramento de tarefas do XM Discover Link via API
Sobre o monitoramento de tarefas do XM Discover Link via API
Você pode monitorar o status dos jobs XM Discover Link por meio do ponto de acesso de API de status sem fazer login no aplicativo Conectores.
Use o serviço API de status para obter as seguintes informações:
- Obter o status de execução do job mais recente se não forem fornecidos parâmetros opcionais.
- Obter métricas para uma execução de job específica se historicalRunId for fornecido.
- Obter métricas acumuladas para um período específico se startDate e endDate forem fornecidas.
Ponto de acesso de API de status
A tabela a seguir fornece detalhes do ponto de extremidade da API de status.
| Parâmetro | Descrição |
| URL da API | O URL do ponto de extremidade:
https://na-data.clarabridge.net/v1/public/job/status/ em que:
|
| Tipo | Utilize o serviço HTTP REST. |
| Método HTTP | Use o método GET para recuperar dados. |
Elementos de entrada
A tabela seguinte fornece informações sobre os elementos de entrada da API de status.
| Elemento | Descrição |
| historicalRunId
(Opcional) |
O ID da sessão de upload. Se omitido e nenhum intervalo de datas for fornecido, retorna o status da última execução do job. Se omitidos e o intervalo de datas forem fornecidos, retorna as métricas acumuladas para o período especificado. |
| startDate
(Opcional) |
Defina a data de início a partir da qual os dados devem ser retornados. |
| Data de término
(Opcional) |
Defina a data final para retornar dados com base no último upload. Se omitido e startDate for fornecido, a data de término será automaticamente definida como a data atual. |
Elementos de saída
A tabela seguinte fornece informações sobre os elementos de saída da API de status.
| Elemento | Descrição |
| job_status | O status do job:
Para obter detalhes, consulte Status do job. |
| job_failure_reason | O motivo para uma falha no job. |
| run_metrics | O parâmetro que indica como um job processou dados (documentos).
O objeto run_metrics pode ter os seguintes valores-chave:
Para obter detalhes, consulte Visualização do status de execução do trabalho. |
Solicitação de amostra
O exemplo a seguir ilustra como solicitar o status de um trabalho usando o respectivo código do.
curl --location --request GET 'https://na-data.clarabridge.net/v1/public/job/status/62da736987c9788b830918e0?apiKey=02e7a0e26b592632dd50f623e974fff5'Resposta de amostra
O exemplo a seguir ilustra uma resposta de amostra sobre o status de um trabalho com falha.
{
"job_status": "Falhado",
"job_failure_reason": "{\"problem\":[{\"requestId":"RQ-MOB-f339aa58-71b6-4a1d-a67c-12b8d3439321","severidade":"ERROR","description":"Limite de
comprimento de 900 caracteres para atributo supportexperitosuccessesp foi excedido, comprimento é 1043\"}],\"status\\\\
""ERER11
": RO43\}],
\"status\\\\"ERER11
"
Respostas de erro
Os códigos de status de resposta HTTP indicam se uma solicitação HTTP específica foi concluída com êxito.
A tabela seguinte fornece informações sobre as potenciais respostas de erro.
| Código HTTP | Mensagem | Solução |
| 404 | Não encontrado | Não existe um trabalho com um ID especificado. Use um código de trabalho diferente. |
| 401 | Não autorizado | Falha na autenticação. Utilize uma chave API diferente. |