Acoustic Connect

v0.0.0

📘

API Documentation

For more information please use the API documentation here.

Set up


Source

To set up the Acoustic Connect connector, you will need API and SFTP credentials:

  1. API Credentials: See how to setup here.
    1. API Key: The unique identifier for the application.
    2. Region Code: Identifies which data center hosts your subscription (e.g., US, EU, or AP).

  2. SFTP Credentials: Setup guide available here.
    1. SFTP Username: Your specific login for the connect domain, usually your email.
    2. Private Key: SSH private key for SFTP server the signal reports are loaded into.

Features


FeatureSupportNotes
Backfill2years on contacts, < 1year on signals reports.
IncrementalSupported on all reports.
API reliability🟢Reliable.

Reports detail


⬇️ Report🔑 Incremental key🔑 Primary key📄 Link to API endpoint
ContactsMODIFIED_DATEUSER_IDQuery Contacts
Behaviour SignalsRECEIVED_TIMESTAMPSIGNAL_IDBehaviour Signals
Email Marketing SignalsTIMESTAMPSIGNAL_IDEmail Marketing Signals
SMS Marketing SignalsTIMESTAMPSIGNAL_IDSMS Marketing Signals
WhatsApp Marketing SignalsTIMESTAMPSIGNAL_IDWhatsApp Marketing Signals

Limitations


📘

SFTP Public Key Registration

  • Contact your CSM if you need assistance registering your Public Key for SFTP access.
🚧

File path/Directory Syntax

  • The path where Acoustic automatically uploads signal report data must start and end with a / (e.g., / for the root folder or /parentfolder/ for a sub-folder).
📘

Behaviour Signals

  • Not all behaviour signals are available across every subscription tier. Verify which signals your specific plan supports.