Genesys Cloud - Developer Community!

 View Only

Sign Up

  • 1.  Survey API Issue

    Posted 21 days ago

    We are using this survey api: post_analytics_surveys_aggregates_query

     

    We use this API to pull surveys each day. However, we discovered we were missing 1,400 surveys over a 30 day period. One of our analysts dug into the issue and found that some surveys are getting stuck between the in progress and completed statuses. In Genesys, it says the survey is completed, but it will not pull through the API as a completed survey.

    If we use the same API, but input the conversation IDs associated with missing surveys, we do get results back. I am confused as to why the API will not pull these missing surveys unless we input the exact conversation ID. Some surveys are pulled out, and others need this extra input.

    Has anyone else had this issue?


    #PlatformAPI

    ------------------------------
    Nick Argeson
    Telephony Admin
    ------------------------------


  • 2.  RE: Survey API Issue

    Posted 13 days ago

    Hi Nick,
    Since this is a potential bug, please work with [Genesys Cloud Care](https://help.mypurecloud.com/articles/contact-genesys-cloud-care/) to resolve this.



    ------------------------------
    Jacob Shaw
    Sr. Software Engineer
    ------------------------------



  • 3.  RE: Survey API Issue

    Posted 13 days ago

    Olá!

    A API post_analytics_surveys_aggregates_query não retorna surveys individualmente, apenas agregações (contagem, métricas sumarizadas).
    Ou seja, ela não é confiável para capturar cada survey concluída.

    Quando a survey está em transição entre In-Progress → Completed, especialmente quando associada a:

    • Interações com wrap-up atrasado,

    • Avaliações finalizadas após o término da sessão,

    • Fluxos que fecham a conexão antes da gravação do registro analítico,

    o registro ainda não aparece nos agregados, mas já existe no detalhe da conversa.

    Por isso, quando você pesquisa usando o ConversationId, o retorno aparece:
    → Você está consultando o registro detalhado, não os agregados.


    O que está acontecendo

    1. O status da survey pode estar Partial ou Finished, porém ainda não contabilizado no dataset de agregação.

    2. O dataset usado pelo endpoint de agregados tem atraso de indexação (latência analítica).

    3. As surveys só aparecem na API APÓS serem consolidadas, o que pode levar até algumas horas dependendo do volume.

    Como resolver

    Para obter todos os surveys individualmente e sem perdas, use este endpoint:

    POST /api/v2/analytics/surveys/query

    Exemplo de filtro recomendado:

    {
      "interval": "2025-01-01T00:00:00.000Z/2025-01-31T23:59:59.000Z",
      "surveyFilters": [
        {
          "type": "surveyState",
          "operator": "IN",
          "values": ["finished", "completed"]
        }
      ],
      "paging": {
        "pageSize": 100,
        "pageNumber": 1
      }
    }

     Recomendação Prática

    Método Pode perder surveys? Para quê serve
    post_analytics_surveys_aggregates_query Sim Relatórios sumarizados
    post_analytics_surveys_query Não Extrair todos os surveys
    Buscar por conversationId Não, mas inviável para volume Correção pontual de dados

     Resumo da Resposta

    O problema ocorre porque o endpoint usado consulta dados agregados que podem estar:

    • atrasados,

    • não indexados,

    • ou não contabilizados ainda.

    Para garantir nenhuma perda, use o endpoint de consulta detalhada (surveys/query), filtrando por surveyState.



    ------------------------------
    Fernando Sotto dos Santos
    Consultor Grupo Casas Bahia
    ------------------------------