Vai alla navigazione

Recupera voci condivise

Recupera un elenco di voci condivise.

Header

xi-api-keystringOpzionale

Parametri di query

page_sizeintegerOpzionalePredefinito a 30

Numero massimo di voci condivise da restituire. Non può superare 100; il valore predefinito è 30.

categoryenumOpzionale
Categoria vocale usata per il filtro
Valori consentiti:
genderstring or nullOpzionale
Genere usato per il filtro
agestring or nullOpzionale

Età usata per il filtro

accentstring or nullOpzionale
Accento usato per il filtro
languagestring or nullOpzionale
Lingua usata per il filtro
localestring or nullOpzionale
Lingua utilizzata per il filtro
searchstring or nullOpzionale
Termine di ricerca usato per il filtro
use_caseslist of strings or nullOpzionale
Caso d'uso impiegato per il filtro
descriptiveslist of strings or nullOpzionale
Termine di ricerca usato per il filtro
featuredbooleanOpzionalePredefinito a false
Filtra le voci in evidenza
min_notice_period_daysinteger or nullOpzionale
Filtra le voci con un periodo di preavviso minimo pari al numero di giorni indicato.
include_custom_ratesboolean or nullOpzionale

Includi/escludi le voci con tariffe personalizzate

include_live_moderatedboolean or nullOpzionale

Includi/escludi le voci moderate in tempo reale

reader_app_enabledbooleanOpzionalePredefinito a false
Filtra le voci abilitate per l'app reader
owner_idstring or nullOpzionale
Filtra le voci in base all'ID del proprietario pubblico
sortenumOpzionalePredefinito a created_date

Criteri di ordinamento. Deve essere uno tra: created_date, usage_character_count_1y, trending, cloned_by_count.

Valori consentiti:
pageintegerOpzionalePredefinito a 0

Risposta

Risposta riuscita
voiceslist of objects
L'elenco delle voci condivise
has_moreboolean
Indica se ci sono altre voci condivise nelle pagine successive.
total_countintegerOpzionalePredefinito a 0
Il numero totale di voci condivise corrispondenti alla query.
last_sort_idstring or nullOpzionale

Errori

422
Unprocessable Entity Error