Skip to main content

Partner API Specs

These specs are for partners who hold data SearchLight does not already collect and want it in a client's reporting. Each spec describes an API that the partner builds and hosts. SearchLight calls it on a schedule and pulls the data.

This is a different model from the Standard Integrations, where a partner delivers files to an S3 bucket in SearchLight's schema.

How it works​

  1. Review the spec for your data type and confirm your API can meet it.
  2. Issue SearchLight a credential for the API (a bearer token or an API key).
  3. Send SearchLight the identifier your system uses for each client location you serve.
  4. SearchLight builds the pull against your API and validates the data with you before it appears for the client.

Specs​

  • Direct Mail API: campaigns and mailed addresses from a direct-mail partner.