> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tyviso.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Api integration

# API Integration

## Introduction

Documentation for the external Events API that allows partners to retrieve their event data.

* Base URL: [https://tracking.tyviso.com](https://tracking.tyviso.com)

Each API key is mapped to a specific partner ID, ensuring partners can only access their own event data.

## Authentication

All endpoints require an API key to be passed in the X-API-Key header. Contact support to obtain your API key.

### Authenticating requests

To authenticate requests, include a 'X-API-Key' header with the value "{YOUR_API_KEY}".

API keys are mapped to specific partner IDs in the system configuration.

## Campaigns

### Get Offers

The Get offers object contains the following fields (please note that this requires authentication).

* id — Unique identifier of the offer
* partner — The partner name associated with the offer
* partnerLogo — URL to the partner's logo image
* ageRestricted — Indicates whether the offer is age-restricted
* terms — Offer terms and conditions
* title — Offer title
* description — Offer description text
* image — Main image URL for the offer
* squareImage — Square variant of the offer image
* offerInfoButtonDiscount — Discount value for the info button (if any)
* offerInfoButtonDescription — Description used for the info button
* offerDiscountCode — Discount code provided by the partner (if any)
* offerDiscountCodeType — Type of discount code (availableAtClick/copyPaste/availableAtCheckout/dynamic/uniqodo)
* hasMultipleCodes — Indicates if multiple discount codes exist

## MyAdvertisers

### Get Offers for MyAdvertisers

Retrieves offers for a specific partner by their ID (please note that this requires authentication).

The offer object contains the following fields:

* id — Unique identifier of the offer
* partner — The partner name associated with the offer
* partnerLogo — URL to the partner's logo image
* ageRestricted — Indicates whether the offer is age-restricted
* terms — Offer terms and conditions
* title — Offer title
* description — Offer description text
* image — Main image URL for the offer
* squareImage — Square variant of the offer image
* offerInfoButtonDiscount — Discount value for the info button (if any)
* offerInfoButtonDescription — Description used for the info button
* offerDiscountCode — Discount code provided by the partner (if any)
* offerDiscountCodeType — Type of discount code (availableAtClick/copyPaste/availableAtCheckout/dynamic/uniqodo)
* hasMultipleCodes — Indicates if multiple discount codes exist