Quickstart

← Back to API Integration Three steps to your first payload. If you can run cURL, you can be reading live event data inside five minutes.

Get your API key

Ask your Tyviso account manager. We issue it against your partner ID and confirm your rate limit at the same time.

Send it as a header

Add X-API-Key to every call. No OAuth flow, no token refresh, no signing.

Read the envelope

Successful responses always wrap your data in { success, data }. Check success first.

Your first call — reward views for January

curl --get "https://tracking.tyviso.com/api/v1/rewards/events" \
  --data-urlencode "type=view" \
  --data-urlencode "start_date=2026-01-01" \
  --data-urlencode "end_date=2026-01-31" \
  --header "X-API-Key: $TYVISO_API_KEY" \
  --header "Accept: application/json"

const url = new URL("https://tracking.tyviso.com/api/v1/rewards/events");
url.search = new URLSearchParams({
  type: "view",
  start_date: "2026-01-01",
  end_date: "2026-01-31",
});

const res = await fetch(url, {
  headers: {
    "X-API-Key": process.env.TYVISO_API_KEY,
    "Accept": "application/json",
  },
});

const { success, data } = await res.json();

Next: Authentication for the full header contract, or jump straight to the endpoint reference.

Last modified on August 25, 2026

Integration Documentation

Getting Started

Platform

Integration

Features

Your first call — reward views for January

​Your first call — reward views for January

Your first call — reward views for January