Skip to main content
syrto_get_search_filter_docs è il catalogo dell’oggetto filters accettato da syrto_search_companies, syrto_aggregate_companies e dagli strumenti radar - syrto_radar_map e syrto_radar_chart accettano lo stesso oggetto nei parametri peer_filters e aggregates. Elenca quali sezioni di filtro esistono e documenta i campi esatti, i tipi e i vincoli di ciascuna. Quei due strumenti accettano un unico oggetto filters invece di molti parametri, il che mantiene compatto il loro schema man mano che il catalogo dei filtri cresce. Questo strumento è ciò che rende il catalogo esplorabile. Non effettua alcuna chiamata API e non consuma quota.

​
Quando usare questo strumento

  • Elencare le sezioni di filtro disponibili e cosa copre ciascuna
  • Ottenere i nomi esatti dei campi di una sezione, i tipi e un esempio JSON prima di costruire un filtro
  • Verificare quali sezioni richiedono il parametro year di primo livello
Strumenti correlati: Ricerca aziende e Aggrega aziende consumano l’oggetto documentato da questo strumento, così come gli strumenti radar. Le stesse sezioni sono riportate anche nella pagina Ricerca aziende.

​
Argomenti

​
string[]
Nomi delle sezioni di cui recuperare la documentazione completa, es. ["anagraphic", "radar"]. Omettilo per ottenere l’indice di tutte le sezioni con i riepiloghi di una riga.Le sezioni sono company_ids, anagraphic, state_aids, people, financial e radar.Un nome di sezione sconosciuto restituisce un errore che elenca quelli validi.

​
Flusso di lavoro

1

Ottieni l'indice

Chiama lo strumento senza argomenti. Ottieni ogni sezione con un riepilogo di una riga e l’indicazione se richiede un year.
2

Recupera le sezioni che ti servono

Chiama di nuovo con sections=[...] per ottenere i nomi esatti dei campi, i tipi, i vincoli e un esempio JSON.
3

Costruisci l'oggetto filters

Componi filters a partire da quegli esempi e passalo a syrto_search_companies o syrto_aggregate_companies.
Ogni nome di sezione è una chiave di primo livello di filters, e i campi documentati si annidano sotto quella chiave - company_ids è esso stesso una chiave di primo livello anziché un oggetto a sé. La sezione financial documenta le chiavi size, employees, metric_filters e consolidated. year, sort_by, after e group_by sono parametri di primo livello degli strumenti di ricerca e aggregazione, non fanno parte di filters. group_by appartiene solo a syrto_aggregate_companies e scompone la popolazione filtrata in un aggregato per ciascuna cella di settore / area / dimensione. Tutti i filtri impostati si combinano in AND, e year è obbligatorio ogni volta che si usa una sezione contrassegnata da requires_year.

​
Risposta

Senza argomenti - l’indice:
​
string
Come le sezioni si compongono nell’oggetto filters.
​
object[]
Una voce per sezione, ciascuna con:
  • name - la chiave di primo livello in filters
  • summary - descrizione di una riga di cosa filtra la sezione
  • requires_year - se l’uso di questa sezione obbliga a passare il year di primo livello
Con sections - la documentazione completa:
​
object[]
Una voce per ogni sezione richiesta, nell’ordine del catalogo, ciascuna con:
  • name - il nome della sezione
  • requires_year - se la sezione obbliga a un year
  • documentation - i campi, i tipi, i vincoli e un esempio della sezione, in markdown

​
Esempio

Ottenere l’indice:
Recuperare due sezioni per intero: