Agora Docs

Interrogazioni

Come leggere elenchi di dati con paginazione, filtri, proiezione dei campi e conteggi.

Gli endpoint che restituiscono elenchi (GET /events, GET /events/{event}/subscriptions…) condividono gli stessi parametri di query.

ParametroSignificato
wherefiltro, come oggetto JSON codificato nell'URL
limitnumero di elementi per pagina: massimo 50 (valori maggiori o non positivi valgono 50)
tokencursore per la pagina successiva o precedente
sort1 (predefinito) o -1: ordine crescente o inverso
fieldscampi da restituire, separati da spazio (fields=id user status)
includerelazioni da includere, separate da spazio (include=user)

Paginazione

La paginazione è a cursore. La risposta ha questa forma:

{ "items": [], "length": 20, "has_more": true, "next": "…", "prev": "…" }

Per la pagina successiva ripeti la stessa richiesta con token=<next>; per la precedente usa token=<prev> e sort=-1. I cursori sono opachi e legati agli stessi filtri: non interpretarli. Mantieni lo stesso sort tra una pagina e l'altra.

Filtri

where è un oggetto JSON, per esempio {"status":1}. Sugli eventi puoi confrontare le date con $gt, $gte, $lt, $lte. Ogni endpoint accetta solo i campi del suo schema (la reference riporta il tipo di where); campi sconosciuti possono essere rifiutati con 400.

Sull'elenco degli eventi, where.name è una ricerca per sottostringa senza distinzione tra maiuscole e minuscole.

Nel corpo delle richieste (POST, PATCH) sono ammessi solo i campi documentati: i campi in più vengono rifiutati.

Conteggi

Gli endpoint …/count accettano lo stesso where e restituiscono un numero.

Esempi

Eventi in corso, conteggio:

GET /events/count?where={"status":1,"date_start":{"$lte":"2026-10-01T08:00:00.000Z"},"date_end":{"$gte":"2026-10-01T08:00:00.000Z"}}

Eventi conclusi, più recenti prima, 20 per pagina:

GET /events?where={"status":1,"date_end":{"$lt":"2026-10-01T08:00:00.000Z"}}&sort=-1&limit=20

Iscrizioni accettate di un evento, solo alcuni campi:

GET /events/evt_9a1/subscriptions?where={"status":"accepted"}&limit=50&fields=id user status

Negli esempi il valore di where va codificato nell'URL (%7B…%7D) e le richieste portano gli header di autenticazione.

Questo articolo ti è stato utile?

In questa pagina