Lister · Requêtes — Analyse des recherches et règles

Affichez les expressions de recherche des clients, les recherches sans résultat et les mesures de clics.

GET/api/v1/search/queries

Requête cURL

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request GET \
  --url 'https://shop.onshopently.com/api/v1/search/queries?limit=20' \
  --header 'Authorization: Bearer EXAMPLE_ACCESS_TOKEN'

Réponse

{
  "data": [
    {
      "clicks": 1,
      "last_seen_at": "2026-01-01T12:00:00Z",
      "query_display": "example",
      "query_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "searches": 1,
      "zero_results": 1
    }
  ],
  "meta": {
    "pagination": {
      "has_more": false,
      "limit": 20,
      "next_cursor": null
    },
    "period": {
      "as_of": "2026-01-02T00:00:00Z",
      "days": 1,
      "started_at": "2026-01-01T00:00:00Z"
    },
    "request_id": "example"
  }
}

Fonctionnement

days: Période du rapport en jours. locale: Langue sélectionnée pour cette requête. source: Source de l'activité enregistrée. market_id: Identifiant de marché renvoyé par le point d'accès au contexte.

query: Texte de recherche ou filtre portant sur ce texte. searches_min: Filtre du nombre minimal de recherches. searches_max: Filtre du nombre maximal de recherches. clicks_min: Filtre du nombre minimal de clics.

clicks_max: Filtre du nombre maximal de clics. zero_results_min: Filtre du nombre minimal de recherches sans résultat. zero_results_max: Filtre du nombre maximal de recherches sans résultat. zero_result_scope: Filtre des recherches avec ou sans occurrences sans résultat.

sort: Ordre de tri sélectionné pour les résultats.

Définissez limit sur un nombre de 1 à 100. C’est le nombre maximal de résultats dans une réponse.

Si has_more vaut true dans meta.pagination, il reste des résultats. Copiez la valeur de next_cursor dans la même section et transmettez-la comme cursor dans la requête suivante.

Autorisations requises

Authentification: Jeton d’accès
Disponible à partir de: STANDARD
Autorisation de la clé: Afficher les analyses de recherchesearch.analytics:read