Quando si recuperano dati tramite l'API Aircall, gli endpoint di elenco restituiscono i risultati utilizzando la paginazione. Questo approccio aiuta a gestire set di dati di grandi dimensioni suddividendo le risposte in più pagine e fornendo informazioni per spostarsi tra le pagine.

Nozioni di base sulla paginazione

I dettagli sulla paginazione sono inclusi nell'oggetto meta della risposta dell'API. Questo oggetto fornisce informazioni chiave sul set di dati corrente e sulla navigazione:

  • count: numero di elementi nella pagina corrente
  • total: numero totale di elementi corrispondenti alla query
  • current_page: numero della pagina corrente
  • per_page: numero di elementi restituiti per pagina
  • next_page_link / previous_page_link: link per spostarsi tra le pagine

Puoi controllare la paginazione utilizzando i seguenti parametri di query:

  • page: numero di pagina (valore predefinito: 1)
  • per_page: numero di risultati per pagina (valore predefinito: 20, massimo: 50)

Esempio

GET /v1/calls?page=2&per_page=50

Limite di 10.000 record

Per motivi di prestazioni, gli endpoint di elenco dell'API Aircall possono recuperare un massimo di 10.000 record per query, anche quando viene utilizzata la paginazione.

Questo limite si applica agli endpoint che restituiscono raccolte di risorse, tra cui:

  • Elenca Tutte le chiamate
  • Elenca tutti i contatti
  • Altri endpoint di elenco simili

Se più di 10.000 record corrispondono a una richiesta, l'API restituirà solo i primi 10.000 risultati. Le pagine oltre questo intervallo non sono accessibili.

Importante: I parametri di paginazione come page e per_page non consentono di aggirare il limite di 10.000 record.

Recuperare più di 10.000 record

Per recuperare set di dati più grandi, suddividi le richieste utilizzando i filtri disponibili, come i parametri basati sul tempo.

Ad esempio, l'endpoint /v1/calls supporta:

  • from: data minima di creazione della chiamata (timestamp UNIX)
  • to: data massima di creazione della chiamata (timestamp UNIX)

Interrogando intervalli di tempo più brevi, ad esempio settimanali o mensili, ogni richiesta può rimanere al di sotto del limite di 10.000 record, consentendo comunque il recupero completo dei dati.

Esempio

GET /v1/calls?from=<timestamp>&to=<timestamp>
Suggerimento: Suddividi le query di grandi dimensioni in intervalli di tempo più brevi per assicurarti che ogni richiesta rispetti il limite di 10.000 record.

Note aggiuntive

  • Il valore massimo di per_page è 50.
  • I parametri di paginazione non consentono di accedere a più di 10.000 record.
  • Alcuni endpoint, come quello delle chiamate, possono includere vincoli aggiuntivi, ad esempio una disponibilità storica limitata.