Felo API PlatformFelo API Platform
Tutti gli endpoint di Apollo
v0.2.0-beta
OpenAPI 3.1.0

Arricchimento in blocco delle persone

Server:https://openapi.felo.ai
Librerie client

Apollo

​

Person and company enrichment, people search, company job postings and news. Requires Felo administrative permission.

Arricchimento in blocco delle persone

​

Arricchisce le persone elencate nell'array details del corpo della richiesta. Usa i campi di dettaglio e i controlli di arricchimento documentati per questo endpoint; non dedurre il contratto di input dell'endpoint per singola persona da questa richiesta in blocco. Richiede autorizzazioni amministrative Felo.

Riferimento prezzi

  • Misurazione: unità di risposta misurate.
  • Stima di riferimento per richiesta: USD 1.7775.
  • Base di costo unitario: USD 0.0.
  • Unità di risorsa: provider_credit.
  • Moltiplicatore di riferimento per il cliente: 1.0. Non applicarlo di nuovo a un importo già addebitato al cliente.
  • Le basi di costo non determinano il prezzo finale per il cliente, anche quando sono zero.

Solo metadati di riferimento, non un preventivo dell'account, né un prezzo garantito o un limite di spesa. I crediti delle risorse non sono crediti Felo. Gli addebiti finali seguono le registrazioni di fatturazione Felo.

Parametri di query
  • reveal_phone_number
    Tipo: boolean
  • run_waterfall_email
    Tipo: boolean
  • run_waterfall_phone
    Tipo: boolean
  • webhook_url
    Tipo: string
    lunghezza minima:  
    1
    lunghezza massima:  
    2048
    Formato: https_url
Corpo
obbligatorio
application/json
  • details
    Tipo: array object[]
    obbligatorio

    Fornisci le informazioni per ogni persona che vuoi arricchire come oggetto all'interno di questo array. Fino a 10 persone.

    Una persona da arricchire. Fornisci tutti gli identificatori disponibili: più sono, più probabile è la corrispondenza.

    • domain
      Tipo: string

      Dominio del datore di lavoro della persona, senza www. Esempio: apollo.io

    • email
      Tipo: string

      Indirizzo email della persona.

    • first_name
      Tipo: string

      Nome, usato con last_name. Esempio: tim

    • hashed_email
      Tipo: string

      Hash MD5 o SHA-256 dell'indirizzo email.

    • id
      Tipo: string

      ID persona Apollo, ad esempio da una ricerca persone.

    • last_name
      Tipo: string

      Cognome, usato con first_name. Esempio: zheng

    • linkedin_url
      Tipo: string

      URL del profilo LinkedIn della persona.

    • name
      Tipo: string

      Nome completo, ad esempio "tim zheng"; sostituisce first_name + last_name.

    • organization_name
      Tipo: string

      Nome del datore di lavoro della persona. Esempio: apollo

Risposte
  • 200
    Tipo: object

    Risposta riuscita

    • credits_consumed
      Tipo: integer

      Campo di risposta

    • error_code
      Tipo: string

      Campo di risposta

    • error_message
      Tipo: string

      Campo di risposta

    • matches
      Tipo: array string[]

      Array di risposta

    • missing_records
      Tipo: integer

      Campo di risposta

    • status
      Tipo: string

      Campo di risposta

    • total_requested_enrichments
      Tipo: integer

      Campo di risposta

    • unique_enriched_records
      Tipo: integer

      Campo di risposta

    • waterfall
      Tipo: object

      Oggetto di risposta

    application/json
  • 400

    Impossibile elaborare la richiesta. Controlla i parametri della richiesta.

  • 401

    È richiesta una chiave API Felo valida.

  • 402

    Impossibile procedere con la richiesta perché non è soddisfatto un requisito di fatturazione.

  • 403

    L'account non è autorizzato a eseguire questa operazione.

  • 429

    È stato raggiunto un limite di richieste o di spesa.

  • 502

    Il servizio non è riuscito a completare la richiesta.

  • 503

    L'API o il servizio di fatturazione è temporaneamente non disponibile.

  • 504

    Si è verificato un timeout durante l'elaborazione della richiesta.

  • default

    Risposta di errore; le risposte passthrough upstream possono usare formati del provider

    application/json
Request Example for post/v1/beta/apollo/people/bulk_match
curl https://openapi.felo.ai/v1/beta/apollo/people/bulk_match \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "details": [
    {
      "first_name": "",
      "last_name": "",
      "name": "",
      "email": "",
      "hashed_email": "",
      "organization_name": "",
      "domain": "",
      "id": "",
      "linkedin_url": ""
    }
  ]
}'
{
  "status": "string",
  "error_code": "string",
  "error_message": "string",
  "total_requested_enrichments": 1,
  "unique_enriched_records": 1,
  "missing_records": 1,
  "credits_consumed": 1,
  "matches": [
    "string"
  ],
  "waterfall": {}
}
Bulk People Enrichment