API de Resultados de Fluxo

A API de Resultados de Fluxo padroniza a troca de dados coletados por um Stack e aplicativos externos de análise/visualização de dados. Os dados abrangidos por esta API são os "resultados" ou "respostas" registradas durante interações com usuários finais através de Jornadas.

Esta API segue o Uso da API de Resultados de Fluxo. Consulte a Especificação de Resultados de Fluxo para mais detalhes sobre como funciona esta especificação aberta para troca de dados gerados por aplicativos de software semelhantes a Fluxos.

Obter todos os Pacotes de Resultados de Fluxo

Solicite uma lista de Pacotes de Resultados de Fluxo disponíveis para o usuário autorizado.

Um Pacote de Resultados de Fluxo é um contêiner e formato de dados que descreve uma coleção de interações ou "respostas" relatadas por usuários finais usando Jornadas. Consulte Especificação de Pacote de Resultados de Fluxo para mais detalhes.

Parâmetros opcionais de consulta:

• stack_uuid: Lista apenas pacotes pelo UUID da Jornada fornecida.

$ curl "https://whatsapp.turn.io/v1/flow-results/packages?stack_uuid=<uuid-da-jornada>" \
  -H "Authorization: Bearer <token>" \
  -H "accept: application/vnd.v1+json"
> {
    "links": {
        "self": "https://whatsapp.turn.io/v1/flow-results/packages",
    },
    "data": [
        {
            "type": "packages",
            "id": "0c364ee1-0305-42ad-9fc9-2ec5a80c55fa",
            "attributes": {
                "title": "Pesquisa padrão",
                "name": "pesquisa-padrao",
                "created": "2015-11-26 02:59:24+00:00",
                "modified": "2015-11-26 02:59:24+00:00"
            }
        },
        {
            "type": "packages",
            "id": "d8d0275f-e108-4528-a259-d738bb626143",
            "attributes": {
                "title": "Pesquisa teste",
                "name": "pesquisa-teste",
                "created": "2015-05-19 15:59:25+00:00",
                "modified": "2015-05-19 15:59:25+00:00"
            }
        }
    ]
}

Obter os Detalhes de um Pacote

Solicite os detalhes de um Pacote de Resultados de Fluxo.

$ curl "https://whatsapp.turn.io/v1/flow-results/packages/<id>" \
    -H 'Authorization: Bearer <token>' \
    -H "Accept: application/vnd.v1+json" \
> {
   "links": {
      "self": "https://whatsapp.turn.io/v1/flow-results/packages/<id>"
   },
   "data": {
      "type": "packages",
      "id": "<id>",
      "attributes": {
         "profile": "flow-results-package",
         "name": "pesquisa-padrao",
         "flow-results-specification": "1.0.0-rc1",
         "created": "2015-11-26 02:59:24+00:00",
         "modified": "2015-11-26 02:59:24+00:00",
         "id": "<id>",
         "title": "Pesquisa padrão",
         "resources": [
            {
               "path": null,
               "api-data-url": "https://whatsapp.turn.io/v1/flow-results/packages/<id>/responses",
               "mediatype": "application/json",
               "encoding": "utf-8",
               "schema": {
                  "language": "eng",
                  "fields": [
                     {
                        "name": "timestamp",
                        "title": "Data e Hora",
                        "type": "datetime"
                     },
                     {
                        "name": "row_id",
                        "title": "ID da Linha",
                        "type": "string"
                     },
                     {
                        "name": "contact_id",
                        "title": "ID do Contato",
                        "type": "integer"
                     },
                     {
                        "name": "session_id",
                        "title": "ID da Sessão",
                        "type": "string"
                     },
                     {
                        "name": "question_id",
                        "title": "ID da Pergunta",
                        "type": "string"
                     },
                     {
                        "name": "response",
                        "title": "Resposta",
                        "type": "any"
                     },
                     {
                        "name": "response_metadata",
                        "title": "Metadados da Resposta",
                        "type": "object"
                     }
                  ],
                  "questions": {
                     "gender": {
                        "type": "select_one",
                        "label": "Selecione seu gênero",
                        "type_options": {
                           "choices": [
                              "Mulher",
                              "Homem",
                              "Outro"
                           ]
                        }
                     },
                     "feeling": {
                        "type": "open",
                        "label": "Como você está?",
                        "type_options": {}
                     }
                  }
               }
            }
         ]
      },
      "relationships": {
         "responses": {
            "links": {
               "related": "https://whatsapp.turn.io/v1/flow-results/packages/<id>/responses"
            }
         }
      }
   }
}

Obter Respostas de um Pacote

Solicite algumas ou todas as respostas de um Pacote de Resultados de Fluxo. Suporta paginação para grandes conjuntos de dados e um conjunto opcional de parâmetros de filtro.

Parâmetros de consulta:

• filter[start-timestamp]: Mostra apenas Respostas registradas após este timestamp.
• filter[end-timestamp]: Mostra apenas Respostas registradas antes ou até este timestamp.
• page[size]: Número de respostas por página solicitado.
• page[afterCursor]: O row_id da resposta para solicitar respostas após este ID, ao paginar para frente.
• page[beforeCursor]: O row_id da resposta para solicitar respostas antes deste ID, ao paginar para trás.

$ curl "https://whatsapp.turn.io/v1/flow-results/packages/<id>/responses" \
  -H "Authorization: Bearer <token>" \
  -H "accept: application/vnd.v1+json"
> {
    "data": {
        "type": "responses",
        "id": "<id>",
        "attributes": {
            "responses": [
                [
                    "2015-11-26 04:33:26",
                    "11393115",
                    "10825354",
                    "47029339",
                    "gender",
                    "Homem",
                    {}
                ],
                [
                    "2015-11-26 04:33:31",
                    "11393119",
                    "10825354",
                    "47029339",
                    "feeling",
                    "Estou bem. Obrigado!",
                    {}
                ],
                ...
            ]
        },
        "relationships": {
            "packages": {
                "links": {
                    "related": "https://whatsapp.turn.io/v1/flow-results/packages/<id>"
                }
            }
        }
    },
    "links": {
        "self": "https://whatsapp.turn.io/v1/flow-results/packages/<id>/responses?page%5Bsize%5D=100",
        "next": "https://whatsapp.turn.io/v1/flow-results/packages/<id>/responses?page%5Bsize%5D=100&page%5BafterCursor%5D=0c364ee1-0305-42ad-9fc9-2ec5a80c55fa",
        "previous": null
    }
}