Assist

Récupérer les sessions en direct

Disponible uniquement pour l’Enterprise Edition (EE).

Renvoie la liste des sessions en direct d’un projet donné.

Méthode

GET

URL

/api/v1/:projectKey/assist/sessions

Paramètres

Name	Type	Description
projectKey	string	L’ID du projet que vous suivez (obligatoire)

En-têtes de la requête

Authorization: {YOUR_ORGANIZATION_API_KEY} : La clé se trouve dans ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

Codes de statut

200 : Réponse envoyée au format JSON dans le corps

Exemple de requête

curl -X GET \
  https://openreplay.example.com/api/v1/aYYaFHiagqdXKEmVlmvJ/assist/sessions \
  -H 'content-type: application/json' \
  -H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'

Exemple de réponse

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

Rechercher des sessions en direct

Recherche dans la liste des sessions en direct d’un projet donné.

Méthode

POST

URL

/api/v1/:projectKey/assist/sessions

Paramètres

Name	Type	Description
projectKey	string	L’ID du projet que vous suivez (obligatoire)

Payload

Name	Type	Description
sort	string	L’attribut de tri (par défaut )
order	string	L’ordre de tri, peut être “DESC” ou “ASC” (par défaut )
page	integer	Le numéro de page pour la pagination (par défaut :1)
limit	integer	Le nombre de sessions par page (par défaut :200)
filters	array of filter	La liste des filtres, voir le tableau suivant (par défaut :[])

objet filter :

Name	Type	Description
value	array of case insensitive strings	La liste des valeurs (par défaut :[])
type	case insensitive string	L’attribut du filtre (obligatoire)
source	case insensitive string	Le nom de l’attribut de métadonnées pour type=metadata (par défaut :"")
operator	case sensitive string	L’opérateur à utiliser pour chaque valeur, peut être “contains” ou “is” (par défaut :“contains”)

La recherche cherchera les sessions en direct dont le nom d’attribut contient le type indiqué et qui ont une valeur contenant l’une des value indiquées.

PS : si values=[], la recherche cherchera les sessions en direct qui possèdent un attribut donné.

Par exemple, si vous recherchez les sessions ayant des métadonnées spécifiques (n’importe quelle valeur) :

{"value": [], "type": "METADATA", "source": "myMeta"}