# Static API

{% hint style="success" %}
If integrated, it should be called each 15-30 minutes to make sure our campaigns are still available, did not run into daily caps or changed targeting / bid.
{% endhint %}

{% hint style="danger" %}
The "Static API key" for requests is adslot specific and available in the adslot details once approved by your account manager.
{% endhint %}

## Eligible Placement & AdSlot Combinations <a href="#eligible-placement-and-adslot-combinations" id="eligible-placement-and-adslot-combinations"></a>

The table below shows all Placement & AdSlot Type combinations that allow you to utilize the Static API integration.

| Placement Type | AdSlot Type | Eligible Integration Type |
| -------------- | ----------- | ------------------------- |
| Website        | Static API  | Static API                |
| Android App    | Static API  | Static API                |
| iOS App        | Static API  | Static API                |
| API / Network  | Static API  | Static API                |

{% hint style="danger" %}
If you integrate the Offerwall API while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to make correct API requests.
{% endhint %}

## Getting Started

Before you start with the integration, make sure you:

* [x] Created an Account
* [x] Added a Placement
* [x] Added an AdSlot

You will find more details here:

{% content-ref url="../../dashboard-setup" %}
[dashboard-setup](https://docs.ayetstudios.com/v/product-docs/dashboard-setup)
{% endcontent-ref %}

## Technical Documentation: Static API <a href="#technical-documentation-static-api" id="technical-documentation-static-api"></a>

API calls return a list of currently running campaigns on our platform which suit your adslot configuration. Can be filtered by additional parameters.

{% hint style="info" %}
**Note:** To pass custom parameters from clicks to conversion callbacks, the tracking\_link parameter in offer objects can be extended with \&custom\_1=... to \&custom\_5=...
{% endhint %}

Follow the link below to get to the detailed technical documentation.

{% embed url="<https://www.ayetstudios.com/openapi/publisher-doc#tag/Static-API>" %}

## CPE Offer Status

If you also request Multi-Reward Offers (CPE Offers) to display them to your users, you can use the CPE Offer Status API to track user progress and build a user journey displaying completed and available tasks.

Follow the link to learn more about the CPE Offer Status API.

{% embed url="<https://www.ayetstudios.com/openapi/publisher-doc#tag/Static-API/operation/get-offers-cpe_status-adslot>" %}

## Conversion Callbacks & Currency Handling <a href="#conversion-callbacks-and-currency-handling" id="conversion-callbacks-and-currency-handling"></a>

Learn about:

* Setting up callbacks
* IP Whitelists
* Securing callbacks using HMAC Security Hash
* Testing callbacks

Click on the link below:

{% content-ref url="../../callbacks-and-testing" %}
[callbacks-and-testing](https://docs.ayetstudios.com/v/product-docs/callbacks-and-testing)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ayetstudios.com/v/product-docs/offerwall/api-integrations/static-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.