Obter interações por IDs

Nome	Tipo	Obrigatório	Descrição	Padrão
interactionIds	string	obrigatório	JSON-encoded array of interaction IDs to fetch, e.g. `["b2fa765e-c62b-4e0b-b1d6-1c67c855f5e0"]`. Passed as a URL-encoded JSON string.	—

Nome

Tipo

Obrigatório

Descrição

Padrão

interactionIds

string

obrigatório

JSON-encoded array of interaction IDs to fetch, e.g. `["b2fa765e-c62b-4e0b-b1d6-1c67c855f5e0"]`. Passed as a URL-encoded JSON string.

—

Respostas

200Interaction details for the requested IDs. `data.interactionDetails.interactions` holds the array.

Response

{  "data": {    "interactionDetails": {      "interactions": [        {          "id": "b2fa765e-c62b-4e0b-b1d6-1c67c855f5e0",          "source": "maps.google.com",          "content": "Great place for dessert!",          "authorName": "Jordan M.",          "category": "Review",          "type": "Review",          "rating": 5,          "date": "2026-05-12T09:22:41+00:00",          "responded": true,          "responseCount": 1,          "canRespond": true,          "responses": [            {              "id": "2090753a-ece6-4837-8336-8494ad308523",              "content": "Thank you so much for the kind words!",              "authorName": "Jenny Home",              "date": "2026-05-13T14:02:00+00:00",              "interactionStatus": "CONFIRMED",              "editedResponse": false            }          ]        }      ]    }  }}

401Unauthenticated, missing or invalid API key.

Busca os detalhes completos das interações correspondentes a um ou mais IDs de interação específicos. Útil quando você tem IDs de interação armazenados e precisa de dados atualizados dessas interações sem percorrer todas as páginas da lista de interações. O corpo da resposta é data.interactionDetails.interactions, um array de objetos de interação (consulte a referência de atributos de interação).

Passe interactionIds como um array JSON codificado para URL. Quando um ID não pertence à sua conta, o endpoint retorna 200 com data.interactionDetails definido como null e um array errors (e.g. SY90001: Not Authorized to access this resource); omitir completamente o parâmetro retorna SY90006.

Caso de uso: hidratar uma lista de acompanhamento armazenada

Se você criar um sistema de notificações que armazena IDs de interação (por exemplo, de avaliações que um usuário marcou com uma estrela), chame este endpoint periodicamente para reidratar essas interações e detectar novos responses publicados pelo proprietário ou uma alteração no indicador responded, sem precisar percorrer novamente toda a lista de avaliações. O responses[].id retornado aqui é o responseId que você passa para Editar uma resposta ou Arquivar uma resposta.

Obter interações por IDs

Parâmetros

Query

Respostas

Caso de uso: hidratar uma lista de acompanhamento armazenada