Assist

Recuperar sessões ao vivo

Retorna a lista de sessões ao vivo de um projeto específico. Opcionalmente, filtre por userId por meio de um parâmetro de consulta.

Padrões aplicados no servidor: sort = timestamp, order = desc, limit = 10, page = 1.

Método

GET

URL

/public/:projectKey/assist/sessions

Parâmetros

Nome	Tipo	Descrição
projectKey	string	A chave do projeto (obrigatório)
userId	string	Valor opcional de `tracker.setUserID` (parâmetro de consulta da URL)

Cabeçalhos da requisição

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

Exemplo de requisição

curl -X GET \
  '{BASE_URL}/public/aYYaFHiagqdXKEmVlmvJ/assist/sessions?userId=mickael@openreplay.com' \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}'

Exemplo de resposta

{
  "data": {
    "total": 1,
    "sessions": [
      {
        "pageTitle": "OpenReplay Blog",
        "sessionID": "6975518573799938",
        "metadata": {},
        "userID": "mickael@openreplay.com",
        "userUUID": "8998545b-553c-4f41-a39d-d7cba7fac2d1",
        "projectKey": "aYYaFHiagqdXKEmVlmvJ",
        "timestamp": 1656437966459,
        "trackerVersion": "3.5.11",
        "userOs": "Mac OS",
        "userBrowser": "Chrome",
        "userBrowserVersion": "103.0.0.0",
        "userDeviceType": "desktop",
        "userCountry": "FR",
        "live": true,
        "projectId": 3
      }
    ],
    "live": true
  }
}

Pesquisar sessões ao vivo

Pesquise a lista de sessões ao vivo de um projeto específico usando um corpo JSON.

Padrões aplicados no servidor quando omitidos: sort = timestamp, order = desc, limit = 10, page = 1.

Método

POST

URL

/public/:projectKey/assist/sessions

Parâmetros

Nome	Tipo	Descrição
projectKey	string	A chave do projeto (obrigatório)

Payload

Nome	Tipo	Descrição
sort	string	O atributo de ordenação (padrão: `timestamp`)
order	string	`asc` ou `desc` (padrão: `desc`)
page	integer	Número da página para paginação (padrão: `1`)
limit	integer	Número de sessões por página (padrão: `10`)
filters	array de filtros	A lista de filtros (padrão: `[]`)

Objeto de filtro:

Nome	Tipo	Descrição
name	string	Atributo do filtro (obrigatório, p. ex. `userId`). Use `METADATA` com `source` abaixo
operator	string	`contains` ou `is` (padrão: `contains`)
value	string[]	A lista de valores (padrão: `[]`)
source	string	Nome do atributo de metadados quando `name = METADATA` (padrão: `""`)

Se value = [], a busca retorna as sessões ao vivo que têm o atributo informado definido (com qualquer valor).

Cabeçalhos da requisição

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

Exemplo de requisição

O exemplo a seguir busca as 10 primeiras sessões ao vivo (ordenadas por timestamp em ordem decrescente) em que userId contém openreplay e metadata.plan é trial ou free.

curl -X POST \
  {BASE_URL}/public/aYYaFHiagqdXKEmVlmvJ/assist/sessions \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}' \
  --data-raw '{
    "filters": [
      { "value": ["trial", "free"], "name": "METADATA", "source": "plan", "operator": "is" },
      { "value": ["openreplay"], "name": "userId", "operator": "contains" }
    ],
    "sort": "timestamp",
    "order": "desc",
    "limit": 10,
    "page": 1
  }'

Exemplo de resposta

{
  "data": {
    "total": 1,
    "sessions": [
      {
        "pageTitle": "OpenReplay Blog",
        "sessionID": "6975518573799185",
        "metadata": { "plan": "trial" },
        "userID": "dev@openreplay.com",
        "userUUID": "8998545b-553c-4f41-a39d-d7cba7fac2d1",
        "projectKey": "aYYaFHiagqdXKEmVlmvJ",
        "timestamp": 1656437966459,
        "trackerVersion": "3.5.11",
        "userOs": "Mac OS",
        "userBrowser": "Chrome",
        "userBrowserVersion": "103.0.0.0",
        "userDeviceType": "desktop",
        "userCountry": "FR",
        "live": true,
        "projectId": 3
      }
    ],
    "live": true
  }
}