Skip to content

Examples use fictional data. Every company, person, address and count in them is invented, and their domains use the reserved .example TLD.

API reference · v1

Everything the product does, available as an endpoint.

The dashboard is a client of this API and nothing more. The same key drives search, campaigns, the inbox and the sending infrastructure underneath them.

Endpoints
83
Reference sections
20
Webhook events
22

Start here

One call, three languages

Every entry in this reference carries the same three tabs, generated from one description of the request — so the curl you copy and the SDK call beside it can never disagree.

curl -X POST "https://beamro.com/api/v1/lookalike" \
  -H "x-api-key: $SALVO_API_KEY" \
  -H "content-type: application/json" \
  -d '{ "domain": "harlowmeadow.example", "limit": 12 }'

Reference map

Getting started

Conventions

  • Versioned in the path

    Every route lives under /v1. Breaking changes get a new prefix; additive fields do not.

  • Money in cents

    Always an integer. spend_cents: 4314 is $43.14 — no floats anywhere near a balance.

  • Times in ISO-8601 UTC

    Ending in Z. Sending windows are the one exception and carry their own tz.

  • Prefixed identifiers

    An id says what it is: cmp_, led_, thr_. Never parse them, only compare them.

  • Paged the same way

    List endpoints take limit and offset and return total.

  • Unknown fields are ignored

    Send extra keys and they are dropped, so a shared filter object is safe to reuse across endpoints.

The full segment taxonomy is listed at GET /v1/segments. Questions the reference does not answer go to support@salvo.example.