Prodege Performance Advertiser Reporting API

https://docs.prodegeads.com/
Admin
This API allows developers to fetch detailed performance reports for advertisers, offering...
Tokens:31,771
Snippets:69
Trust Score:3.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### API Request URL Examples for Prodegeads Reports

Source: https://docs.prodegeads.com/publisher-apis/publisher-reporting-api

Demonstrates how to construct API request URLs to fetch affiliate reports. These examples show how to specify date ranges, data fields, grouping parameters, and filters.

```URL
https://api.adgatemedia.com/v1/affiliate/report?aff=AFFID&api_key=APIKEY&start_date=11-22-2020&end_date=12-22-2020&data[]=country&data[]=offer_id&limit=100
```

```URL
https://api.adgatemedia.com/v1/affiliate/report?aff=AFFID&api_key=APIKEY&start_date=2018-01-01&end_date=2018-01-02&options[]=impressions&intervals[]=dt&options[]=cpm&filters[offer_id]=16146,15506
```

--------------------------------

### Example POST Request to Update Devices

Source: https://docs.prodegeads.com/publisher-apis/user-based-api-v1/post-devices

This example demonstrates how to send a POST request to the ProdegeAds API to update a user's devices. It includes common HTTP client libraries in Python and JavaScript. Ensure you replace placeholder values with your actual affiliate ID, API key, wall code, and user ID.

```python
import requests

url = "https://api.adgatemedia.com/v1/user-based-api/devices"

params = {
    "aff_id": "YOUR_AFF_ID",
    "api_key": "YOUR_API_KEY",
    "wall_code": "YOUR_WALL_CODE",
    "user_id": "YOUR_USER_ID"
}

data = {
    "devices": ["iphone", "ipad", "android"]
}

response = requests.post(url, params=params, json=data)

if response.status_code == 200:
    print("Success:", response.json())
else:
    print("Error:", response.status_code, response.text)
```

```javascript
const axios = require('axios');

const url = 'https://api.adgatemedia.com/v1/user-based-api/devices';

const params = {
    aff_id: 'YOUR_AFF_ID',
    api_key: 'YOUR_API_KEY',
    wall_code: 'YOUR_WALL_CODE',
    user_id: 'YOUR_USER_ID'
};

const data = {
    devices: ['iphone', 'ipad', 'android']
};

axios.post(url, data, { params: params })
    .then(response => {
        console.log('Success:', response.data);
    })
    .catch(error => {
        console.error('Error:', error.response.status, error.response.data);
    });

```

--------------------------------

### PHP Postback Data Handling and Object Parsing

Source: https://docs.prodegeads.com/postbacks/php-postback-examples

This PHP script processes postback data from AdGate Media. It first validates the IP address to ensure the request originates from AdGate Media. If valid, it retrieves the data from the $_GET superglobal and parses it into a 'Postback' object. The example also includes a demonstration of how to process specific data, such as handling chargebacks.

```php
<?php

/**
 * For a plain PHP page to receive the postback data from AdGate Media you may simply
 * retrieve the array from the global $_GET variable. To ensure that the data is coming
 * from AdGate Media check that the server sending the data is from AdGate Media by the ip
 * address as listed on your affiliate panel at http://adgatemedia.com under
 * the Postbacks Section and the Postback Information heading.
 */
define('AdGate_IP', '123.123.123.123'); // Note: as noted above change the IP to match what is in your affiliate panel.
protected $ip = $_SERVER['REMOTE_ADDR'];
protected $data = null;


/**
 * Check if the Remote Address is AdGate Media
 * if it is not throw an Exception
 */
if($ip === AdGate_IP)
{
    $data = $_GET;
    // Process or Persist Data here inline or via a function call.
} else {
    // Throw either a custom Exception or just throw a generic \Exception
    throw new InvalidIPException();
}


/**
 * The data array will contain all the macros you included under the Postbacks section of your
 * affiliate panel at http://adgatemedia.com. The array is keyed by the names you assigned to each macro
 * when you constructed the url e.g., http://yoururl.com/postback/?tx_id={transaction_id}
 * the transaction_id macro's data will have a key of 'tx_id' in the $data array: $data['tx_id'];
 *
 * Possible Macros
 * For a list of possible macros see your affiliate panel at http://adgatemedia.com under the
 * Postbacks section and the heading Postback Information.
 *
 * Parsing:
 * From the data array you may parse the data into an object, supply it to an SQL query, or do
 * any needed processing or persisting required by your application.
 *
 */

/**
 * Parse into an Object Example
 *
 * You can import the Postback data into your own custom Postback object.
 * For a simple solution you could use a Collection object to hold the Postback data,
 * if you are using a framework consider using their supplied facilities for holding and
 * persisting data. Refer to your frameworks documentation.
 */
$postback = new Postback($data);


/**
 * Processing Example
 * This example shows sending an notification to an admin when receiving a charge back of a conversion
 * being sent to the postback url.
 *
 * The example uses a Static Notify class, use your own notification class or one provided by your framework
 * of choice.
 */
if($data['status'] == 0)
{
    Notify::admin("Conversion charge back for offer " . $data['offer_id'] . " on transaction " . $data['tx_id'] . "!");
}

```

--------------------------------

### GET /v2/offers

Source: https://docs.prodegeads.com/publisher-apis/offers-api-1

Retrieves a list of compatible offers based on specified parameters. It is recommended to fetch offers every 10 minutes from the backend.

```APIDOC
## GET /v2/offers

### Description
Retrieves a list of compatible offers based on specified parameters. It is recommended to fetch offers every 10 minutes from the backend.

### Method
GET

### Endpoint
https://api.adgatemedia.com/v2/offers

### Parameters
#### Query Parameters
- **aff** (Integer) - Required - Your affiliate ID.
- **api_key** (String) - Required - Your API key.
- **wall_code** (String) - Required - Wall code for filtering offers.
- **countries** (String) - Optional - Filter by specific countries (comma-separated ISO country codes).
- **offer** (String) - Optional - Filter by specific offers (comma-separated offer IDs).
- **paymin** (Decimal) - Optional - Filter by offers above a minimum payout (USD).
- **minepc** (Decimal) - Optional - Filter by offers above a minimum EPC (USD).
- **mobile_only** (Integer) - Optional - Filter for mobile-only offers (1) or all offers (0). Default is 0.
- **categories** (String) - Optional - Filter by offer categories (comma-separated category IDs).
- **orderby** (String) - Optional - Order results by `payout`, `epc`, or `id`. Default is `epc`.
- **take** (Integer) - Optional - Limit the number of results.
- **skip** (Integer) - Optional - Skip a number of results.

### Request Example
```json
{
  "request": "GET https://api.adgatemedia.com/v2/offers?aff=60000&api_key=941bd1fecf7e6596823b895e04df3a0c&wall_code=nQug&countries=gb,us,ca&paymin=0.50&mobile_only=1&orderby=payout&take=100"
}
```

### Response
#### Success Response (200)
- **offers** (Array) - List of offer objects.
  - **offer_id** (Integer) - The unique ID of the offer.
  - **name** (String) - The name of the offer.
  - **description** (String) - A description of the offer.
  - **payout** (Decimal) - The payout for completing the offer.
  - **epc** (Decimal) - Earnings Per Click for the offer.
  - **thumbnail_url** (String) - URL for the offer's thumbnail.
  - **display_url** (String) - URL to display for the offer.
  - **countries** (Array) - List of country codes where the offer is available.
  - **categories** (Array) - List of category IDs the offer belongs to.

#### Response Example
```json
{
  "offers": [
    {
      "offer_id": 4849,
      "name": "Example Mobile Game",
      "description": "Download and play this exciting new mobile game!",
      "payout": 1.50,
      "epc": 0.10,
      "thumbnail_url": "https://example.com/thumbnail.jpg",
      "display_url": "https://example.com/offer",
      "countries": ["US", "CA"],
      "categories": [1, 11]
    }
  ]
}
```
```

--------------------------------

### GET /v3/offers

Source: https://docs.prodegeads.com/publisher-apis/offers-api

Retrieves a complete list of offers compatible with virtual currency applications. This API should be called periodically from the backend, ideally every 10 minutes.

```APIDOC
## GET /v3/offers

### Description
Retrieves a complete list of offers compatible with virtual currency applications. This API should be called periodically from the backend, ideally every 10 minutes.

### Method
GET

### Endpoint
`https://api.adgatemedia.com/v3/offers`

### Parameters
#### Query Parameters
- **aff** (Integer) - Required - Your affiliate ID. Can be found on the Offers API page.
- **api_key** (String) - Required - Your API key. Can be found on the Offers API page.
- **wall_code** (String) - Required - Wall code that can be found on the AdGate Rewards page.

### Request Example
```json
{
  "aff": 60000,
  "api_key": "941bd1fecf7e6596823b895e04df3a0c",
  "wall_code": "nQug"
}
```

### Response
#### Success Response (200)
- **offers** (Array) - A list of available offers.
  - **offer_id** (Integer) - The unique identifier for the offer.
  - **name** (String) - The name of the offer.
  - **description** (String) - A description of the offer.
  - **icon_url** (String) - The URL of the offer's icon.
  - **payout** (Float) - The payout for completing the offer.
  - **currency** (String) - The currency of the payout.
  - **actions** (Array) - A list of actions required to complete the offer.
    - **name** (String) - The name of the action.
    - **instructions** (String) - Instructions for completing the action.

#### Response Example
```json
{
  "offers": [
    {
      "offer_id": 12345,
      "name": "Download and Play Game",
      "description": "Download this game and reach level 10 to earn rewards.",
      "icon_url": "https://example.com/icon.png",
      "payout": 1.50,
      "currency": "virtual_currency",
      "actions": [
        {
          "name": "Download",
          "instructions": "Click here to download."
        },
        {
          "name": "Reach Level 10",
          "instructions": "Play the game until you reach level 10."
        }
      ]
    }
  ]
}
```
```

--------------------------------

### User Based API (v1) - Get Offers By Ids

Source: https://docs.prodegeads.com/publisher-apis

Gets the available information for the provided offer IDs, including interaction history.

```APIDOC
## GET /publisher-apis/user-based-api-v1/get-offers-by-ids

### Description
Retrieves detailed information, including interaction history, for specified offer IDs.

### Method
GET

### Endpoint
/publisher-apis/user-based-api-v1/get-offers-by-ids

### Parameters
#### Query Parameters
- **offerIds** (array of strings) - Required - A list of offer IDs to retrieve information for.
- **userId** (string) - Required - The unique identifier for the user.

### Request Example
```
GET /publisher-apis/user-based-api-v1/get-offers-by-ids?offerIds=offer_123,offer_456&userId=some_user_id
```

### Response
#### Success Response (200)
- **offers** (array) - A list of offer details.
  - **offerId** (string) - The unique identifier for the offer.
  - **title** (string) - The title of the offer.
  - **description** (string) - A description of the offer.
  - **points** (integer) - The number of points that can be earned.
  - **interactionHistory** (object) - Details of user interaction with the offer.

#### Response Example
```json
{
  "offers": [
    {
      "offerId": "offer_123",
      "title": "Special Deal",
      "description": "Get this exclusive deal now!",
      "points": 100,
      "interactionHistory": {
        "status": "completed",
        "timestamp": "2023-10-27T10:00:00Z"
      }
    }
  ]
}
```
```

--------------------------------

### GET /websites/prodegeads

Source: https://docs.prodegeads.com/publisher-apis/user-based-api-v1/get-offers

Retrieves a list of available offers from ProdegeAds. Each offer includes details such as ID, title, requirements, and expiration.

```APIDOC
## GET /websites/prodegeads

### Description
Retrieves a list of offers available on ProdegeAds. The response includes detailed information for each offer, such as its unique identifier, display title, specific user requirements, and expiration timestamp.

### Method
GET

### Endpoint
/websites/prodegeads

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
An array of offer objects will be returned. Each offer object contains the following fields:

- **id** (int) - Offer ID
- **anchor** (string) - Offer title to display to users
- **things_to_know** (array) - Offer information that can be presented as a bullet-point list
- **session_hours** (int) - Offer is valid for that many hours
- **offer_expires_at** (int) - Offer expiration timestamp
- **requirements** (string) - What the user should do to complete an offer

#### Response Example
```json
{
  "offers": [
    {
      "id": 341022,
      "anchor": "Playstation 5",
      "things_to_know": [
        "Enter to win a Playstation 5!",
        "You must click \"Allow\" if tracking permission is requested within the app."
      ],
      "session_hours": 720,
      "offer_expires_at": 1741370828,
      "requirements": "Sign up with valid information and complete the full survey."
    }
  ]
}
```
```

--------------------------------

### User Based API (v1) - Get Offers

Source: https://docs.prodegeads.com/publisher-apis

Main API endpoint to fetch available offers for a particular user. Use this to display offers in your offer wall.

```APIDOC
## GET /publisher-apis/user-based-api-v1/get-offers

### Description
Fetches available offers for a specific user to display in an offer wall.

### Method
GET

### Endpoint
/publisher-apis/user-based-api-v1/get-offers

### Parameters
#### Query Parameters
- **userId** (string) - Required - The unique identifier for the user.

### Request Example
```
GET /publisher-apis/user-based-api-v1/get-offers?userId=some_user_id
```

### Response
#### Success Response (200)
- **offers** (array) - A list of available offers.
  - **offerId** (string) - The unique identifier for the offer.
  - **title** (string) - The title of the offer.
  - **description** (string) - A description of the offer.
  - **points** (integer) - The number of points that can be earned.

#### Response Example
```json
{
  "offers": [
    {
      "offerId": "offer_123",
      "title": "Special Deal",
      "description": "Get this exclusive deal now!",
      "points": 100
    }
  ]
}
```
```

--------------------------------

### Example API Response Structure for Affiliate Reports

Source: https://docs.prodegeads.com/publisher-apis/publisher-reporting-api

Illustrates the JSON structure of a typical response from the Prodegeads API for affiliate reports. It includes sample data for individual results, aggregated total columns, and pagination information.

```json
{
    "data": {
        "results": [
            {
                "offer_id": 15506,
                "offer_name": "Survey Sample Savings - Burger King (US) (Incentive)",
                "unique_clicks_count": 34347,
                "conversions_count": 3116,
                "payout_sum": 5608.8,
                "conversion_rate": 0.0907,
                "ppc": 0.16,
                "country_code": "US"
            },
            {
                "offer_id": 17192,
                "offer_name": "Lifesum iPhone Burst (US) (Incentive)",
                "unique_clicks_count": 7552,
                "conversions_count": 3442,
                "payout_sum": 1652.16,
                "conversion_rate": 0.4558,
                "ppc": 0.21,
                "country_code": "US"
            }
        ],
        "totalColumns": {
            "unique_clicks_count": 41899,
            "conversions_count": 6558,
            "payout_sum": 7260.96,
            "ppc": 0.17,
            "conversion_rate": 0.1565
        },
        "paging": {
            "next": null,
            "prev": null
        }
    },
    "status": "success"
}
```

--------------------------------

### PHP PDO Postback Handling with IP Validation

Source: https://docs.prodegeads.com/postbacks/php-postback-examples

This snippet demonstrates how to receive and process postback data in plain PHP using a PDO database connection. It includes validation to ensure the request originates from a trusted IP address (AdGate Media) before processing the $_GET data. The example shows how to insert data into a 'Postbacks' table and includes a basic notification mechanism for specific events.

```php
<?php

/**
 * For a plain PHP page to receive the postback data from AdGate Media you may simply
 * retrieve the array from the global $_GET variable. To ensure that the data is coming
 * from AdGate Media check that the server sending the data is from AdGate Media by the ip
 * address as listed on your affiliate panel at http://adgatemedia.com under
 * the Postbacks Section and the Postback Information heading.
 */
define('AdGate_IP', '123.123.123.123'); // Note: as noted above change the IP to match what is in your affiliate panel.
protected $ip = $_SERVER['REMOTE_ADDR'];
protected $data = null;
protected $servername = "localhost";
protected $username = "username";
protected $password = "password";
protected $dbname = "app";


/**
 * Check the Remote Address is AdGate Media
 * if it is not throw an Exception
 */
if($ip === AdGate_IP)
{
    $data = $_GET;
    // Process or Persist Data here inline or via a function call.
} else {

     // Throw either a custom Exception or just throw a generic \Exception
    throw new InvalidIPException();
}


/**
 * The data array will contain all the macros you included under the Postbacks section of your
 * affiliate panel at http://adgatemedia.com. The array is keyed by the names you assigned to each macro
 * when you constructed the url e.g., http://yoururl.com/postback/?tx_id={transaction_id}
 * the transaction_id macro's data will have a key of 'tx_id' in the $data array: $data['tx_id'];
 *
 * Possible Macros
 * For a list of possible macros see your affiliate panel at http://adgatemedia.com under the
 * Postbacks section and the heading Postback Information.
 *
 * Parsing:
 * From the data array you may parse the data into an object, supply it to an SQL query, or do
 * any needed processing or persisting required by your application.
 *
 */


/**
 * Inline SQL Query Example
 */
try {
    $conn = new PDO("mysql:host=$servername;dbname=$dbname", $username, $password);
    // set the PDO error mode to exception
    $conn->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
    $conn->prepare("INSERT INTO Postbacks (tx_id, user_id, offer_id) VALUES (:tx_id,:user_id. :offer_id)");
    $conn->bindValue(':tx_id', $data['tx_id']);
    $conn->bindValue(':user_id', $data['user_id']);
    $conn->bindValue('offer_id', $data['offer_id']);
    // use exec() because no results are returned
    $conn->exec();
    echo "New Postback recorded successfully";
}
catch(PDOException $e)
{
    echo $sql . "<br>" . $e->getMessage();
}

$conn = null;

/**
 * Processing Example
 * This example shows sending an notification to an admin when receiving a charge back of a conversion
 * being sent to the postback url.
 *
 * The example uses a Static Notify class, use your own notification class or one provided by your framework
 * of choice.
 */
if($data['status'] == 0)
{
    Notify::admin("Conversion charge back for offer " . $data['offer_id'] . " on transaction " . $data['tx_id'] . "!");
}

```

--------------------------------

### Get Offers API

Source: https://docs.prodegeads.com/publisher-apis/user-based-api-v1

Retrieves a list of optimized offers for a specific user based on their geolocation, device, and user history. This endpoint should be called in real-time.

```APIDOC
## GET /v1/user-based-api/offers

### Description
Retrieves a list of optimized offers for a specific user. The offers are tailored based on the user's geolocation, device, and past interactions. This endpoint is intended for real-time calls and results should not be cached.

### Method
GET

### Endpoint
https://api.adgatemedia.com/v1/user-based-api/offers

### Parameters
#### Query Parameters
- **aff_id** (integer) - Required - Your affiliate ID.
- **api_key** (string) - Required - Your API key.
- **user_id** (string) - Required - The unique identifier for the user.
- **wall_code** (string) - Optional - A code to specify a particular offer wall.

### Request Example
```
https://api.adgatemedia.com/v1/user-based-api/offers?aff_id=60000&api_key=abcdef&user_id=user12345&wall_code=nQ
```

### Response
#### Success Response (200)
- **offers** (array) - A list of available offers.
  - **offer_id** (integer) - The unique ID of the offer.
  - **name** (string) - The name of the offer.
  - **description** (string) - A description of the offer.
  - **payout** (float) - The reward for completing the offer.
  - **thumbnail** (string) - URL to the offer's thumbnail image.

#### Response Example
```json
{
  "offers": [
    {
      "offer_id": 123,
      "name": "Complete Survey",
      "description": "Earn virtual currency by completing this survey.",
      "payout": 10.50,
      "thumbnail": "https://example.com/thumbnail.png"
    }
  ]
}
```
```

--------------------------------

### ProdegeAds API Example Response - JSON

Source: https://docs.prodegeads.com/index

This JSON object represents a typical response from the ProdegeAds API, detailing campaign performance metrics for specific dates and providing aggregated totals. It includes fields like unique impressions, clicks, conversions, costs, CPM, and RPC.

```json
{
    "data": {
        "results": [
            {
                "dt": "2015-06-02",
                "unique_impressions_count": 23976,
                "unique_clicks_count": 8595,
                "conversions_count": 721,
                "costs": 1297.8,
                "cpm": 54.13,
                "rpc": 0.15
            },
            {
                "dt": "2015-06-01",
                "unique_impressions_count": 1632,
                "unique_clicks_count": 286,
                "conversions_count": 12,
                "costs": 21.6,
                "cpm": 13.24,
                "rpc": 0.07
            }
        ],
        "totalColumns": {
            "unique_impressions_count": 25608,
            "unique_clicks_count": 8881,
            "conversions_count": 733,
            "cost": 1319.4,
            "cpm": 51.52
        }
    },
    "status": "success"
}
```

--------------------------------

### GET /v1/user-based-api/offers

Source: https://docs.prodegeads.com/publisher-apis/user-based-api-v1/get-offers

Retrieves a list of available offers for a specific affiliate and user. This endpoint requires several query parameters to identify the affiliate and user, and supports optional parameters for filtering and targeting.

```APIDOC
## GET /v1/user-based-api/offers

### Description
Retrieves a list of available offers based on affiliate and user information. This endpoint is crucial for displaying relevant offers to end-users.

### Method
GET

### Endpoint
https://api.adgatemedia.com/v1/user-based-api/offers

### Parameters
#### Query Parameters
- **aff_id** (Integer) - Required - Your affiliate ID.
- **api_key** (String) - Required - Your API key.
- **wall_code** (String) - Required - Wall code for offer retrieval.
- **user_id** (String) - Required - The affiliate's user ID.
- **ip** (String) - Required - IP address (v4 or v6) for geographical targeting.
- **user_agent** (String) - Required - The end-user's user agent string for device targeting.
- **in_app** (String) - Optional - Set to "true" to filter for offers compatible with app stores, otherwise "false".
- **rank_method** (String) - Optional - Determines offer ranking. Accepts "cpm" or "cr".
- **s2** (String) - Optional - SubID 2 for tracking.
- **s3** (String) - Optional - SubID 3 for tracking.
- **s4** (String) - Optional - SubID 4 for tracking.
- **s5** (String) - Optional - SubID 5 for tracking.
- **lang** (String) - Optional - Desired language for offers (e.g., "en-US"). Defaults to English.
- **categories** (String) - Optional - Comma-separated list of app metadata categories to include (e.g., "game*,entertainment").
- **exclude_categories** (String) - Optional - Comma-separated list of app metadata categories to exclude (e.g., "game*,entertainment").
- **is_game** (String) - Optional - Filter for "true" (games only) or "false" (non-games only).
- **age** (Integer) - Optional - User's age for age-targeted offers.
- **gender** (String) - Optional - User's gender for gender-targeted offers (e.g., "male").
- **override_w2m_devices** (String) - Optional - A comma-separated list of devices the user owns (e.g., "iphone,android"). Used when user_agent is a desktop device.

### Request Example
```json
{
  "query": {
    "aff_id": 60000,
    "api_key": "941bd1fecf7e6596823b895e04df3a0c",
    "wall_code": "nQug",
    "user_id": "user12345",
    "ip": "127.0.0.1",
    "user_agent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0",
    "in_app": "false",
    "rank_method": "cpm",
    "lang": "en-US",
    "categories": "game*",
    "age": 24,
    "gender": "male"
  }
}
```

### Response
#### Success Response (200)
- **offers** (Array) - A list of offer objects.
  - **offer_id** (Integer) - The unique ID of the offer.
  - **name** (String) - The name of the offer.
  - **description** (String) - A description of the offer.
  - **payout** (Float) - The payout amount for the offer.
  - **thumbnail** (String) - URL to the offer's thumbnail image.
  - **preview_url** (String) - URL to preview the offer.
  - **external_url** (String) - The external URL for the offer.
  - **count** (Integer) - Number of available slots for the offer.
  - **rank** (Integer) - The rank of the offer based on the `rank_method`.
  - **countries** (Array) - List of country codes where the offer is available.
  - **categories** (Array) - List of categories the offer belongs to.

#### Response Example
```json
{
  "offers": [
    {
      "offer_id": 12345,
      "name": "Example Game Offer",
      "description": "Play this game and earn rewards!",
      "payout": 1.50,
      "thumbnail": "https://example.com/thumbnail.png",
      "preview_url": "https://example.com/preview",
      "external_url": "https://example.com/offer",
      "count": 100,
      "rank": 1,
      "countries": ["US", "CA"],
      "categories": ["game", "action"]
    }
  ]
}
```
```

--------------------------------

### Response Meta Information

Source: https://docs.prodegeads.com/publisher-apis/user-based-api-v1/get-offers-by-ids

Provides details about the meta object returned in API responses, including warnings.

```APIDOC
## Response Meta

The response retrieves a meta object containing miscellaneous information about the endpoint such as warnings, total count, etc.

### Warnings

The following is a list of warnings retrieved in the endpoint:

| Name           | Description                                                                 |
| -------------- | --------------------------------------------------------------------------- |
| private_relay | Returns true or false indicating if the user is using iCloud Private Relay. |

**Sample Response**

```json
{
  "data": [
    // ...
  ],
  "meta": {
    "warnings": {
      "private_relay": true
    }
  }
}
```
```

--------------------------------

### Offer Event Type IDs

Source: https://docs.prodegeads.com/publisher-apis/user-based-api-v1/get-offers

This table lists the available offer event type IDs and their corresponding descriptions. These IDs are crucial for categorizing different types of events within the Prodegeads system, such as installs, purchases, and various dynamic events.

```text
ID   | Type                     |
| ---- | ------------------------ |
| 1    | Install                  |
| 2    | Event                    |
| 3    | Purchase                 |
| 4    | Dynamic Event: Adjust    |
| 5    | Dynamic Event: Playtime  |
| 6    | Dynamic Event: AppsFlyer |
| NULL | N/A                      |
```

--------------------------------

### GET /v1/advertiser/report

Source: https://docs.prodegeads.com/index

Fetches advertiser performance reports. All monetary values are in dollars as decimals. Please allow for long timeouts for each request as responses are not instant.

```APIDOC
## GET /v1/advertiser/report

### Description
Fetches advertiser performance reports. Allows for filtering and grouping by various parameters.

### Method
GET

### Endpoint
`https://api.adgatemedia.com/v1/advertiser/report`

### Parameters
#### Query Parameters
- **api_key** (String) - Required - Your API key. Can be found on the Reporting API page.
- **start_date** (String) - Required - Start date of report in mm-dd-YYYY format.
- **end_date** (String) - Required - End date of report in mm-dd-YYYY format.
- **timezone** (String) - Optional - IANA Timezone. If not provided, defaults to `America/Los_Angeles`.
- **data[]** (Array of Strings) - Optional - Data columns to display and group by. Accepted values: `offer_id`, `offer_event`, `country`, `is_mobile`, `browser`, `os`, `device`, `source`, `aff_id`.
- **intervals[]** (Array of Strings) - Optional - Group response by specific time periods. Accepted values: `m` (Month), `dt` (Day), `h` (Hour).
- **filters[offer_id]** (String) - Optional - Filter by specified offer IDs. Separate multiple values with commas.
- **filters[country]** (String) - Optional - Filter by specified countries using ISO standards (e.g., `US,GB`).
- **filters[is_mobile]** (String) - Optional - Filter by mobile/tablet traffic. Use `0` for desktop, `1` for mobile/tablet.
- **options[]** (Array of Strings) - Optional - Additional data to include in the response. Accepted values: `offer_impressions`, `user_impressions`, `cpm`, `app_id`, `offer_wall_position_avg`.

### Request Example
```
GET https://api.adgatemedia.com/v1/advertiser/report?api_key=941bd1fecf7e6596823b895e04df3a0c&start_date=01-30-2020&end_date=02-01-2020&data[]=offer_id&data[]=country&intervals[]=m&filters[country]=US,GB
```

### Response
#### Success Response (200)
- **data** (Object) - Contains the report results and total columns.
  - **results** (Array of Objects) - An array of report data objects.
    - **offer_id** (Integer) - Prodege's internal offer ID.
    - **offer_name** (String) - Name of the offer.
    - **is_mobile** (Boolean) - Indicates if the traffic is from a mobile device.
    - **unique_impressions_count** (Integer) - Count of unique impressions.
    - **unique_clicks_count** (Integer) - Count of unique clicks.
    - **conversions_count** (Integer) - Count of conversions.
    - **costs** (Float) - Total cost for the period.
    - **cpm** (Float) - Cost per thousand impressions.
    - **rpc** (Float) - Revenue per click.
    - **country_code** (String) - ISO country code.
  - **totalColumns** (Object) - Summary of total counts and calculated values.
    - **unique_impressions_count** (Integer)
    - **unique_clicks_count** (Integer)
    - **conversions_count** (Integer)
    - **cost** (Float)
    - **cpm** (Float)
    - **calculated_cpc** (Float)
- **status** (String) - "success"

#### Response Example
```json
{
    "data": {
        "results": [
            {
                "offer_id": 15506,
                "offer_name": "Survey Sample Savings - Burger King (US) (Incentive)",
                "is_mobile": true,
                "unique_impressions_count": 91879,
                "unique_clicks_count": 34268,
                "conversions_count": 3105,
                "costs": 5589,
                "cpm": 60.83,
                "rpc": 0.16,
                "country_code": "US"
            },
            {
                "offer_id": 17192,
                "offer_name": "Lifesum iPhone Burst (US) (Incentive)",
                "is_mobile": true,
                "unique_impressions_count": 25527,
                "unique_clicks_count": 7552,
                "conversions_count": 3442,
                "costs": 1652.16,
                "cpm": 64.72,
                "rpc": 0.21,
                "country_code": "US"
            }
        ],
        "totalColumns": {
            "unique_impressions_count": 117406,
            "unique_clicks_count": 41820,
            "conversions_count": 6547,
            "cost": 7241.16,
            "cpm": 61.68,
            "calculated_cpc": 0.17
        }
    },
    "status": "success"
}
```
```

--------------------------------

### Sample API Response Meta

Source: https://docs.prodegeads.com/publisher-apis/user-based-api-v1/get-offers-by-ids

This JSON structure represents a sample API response, including a 'meta' object that contains 'warnings'. The 'private_relay' warning indicates whether the user is using iCloud Private Relay.

```json
{
  "data": [
    // ...
  ],
  "meta": {
    "warnings": {
      "private_relay": true
    }
  }
}
```

--------------------------------

### Offer Event Types Table

Source: https://docs.prodegeads.com/publisher-apis/user-based-api-v1/get-offers-by-ids

This table lists the available offer event type IDs and their corresponding descriptions used in the API. IDs range from 1 to 6, with NULL representing N/A.

```markdown
| ID   | Type                     |
| ---- | ------------------------ |
| 1    | Install                  |
| 2    | Event                    |
| 3    | Purchase                 |
| 4    | Dynamic Event: Adjust    |
| 5    | Dynamic Event: Playtime  |
| 6    | Dynamic Event: AppsFlyer |
| NULL | N/A                      |
```

--------------------------------

### Testing and Troubleshooting

Source: https://docs.prodegeads.com/postbacks/postback-information

Instructions for testing postback functionality and troubleshooting issues.

```APIDOC
## Testing and Troubleshooting

### Description
To test the postback functionality on your AdGate Rewards offer wall, you may enable the "Test Mode" feature in your offer wall settings. Enabling Test Mode will create an offer at the top of your offer wall. This offer will convert immediately upon click for easy postback testing. We do not recommend enabling this feature on a live offer wall.

To troubleshoot any postback issues, you may visit your Postback Reports page here: [https://dash.adgatemedia.com/affiliate/reports/postbacks](https://dash.adgatemedia.com/affiliate/reports/postbacks)

This page will show a 30 day history of all postbacks on your account.
```

--------------------------------

### GET /v1/user-based-api/offer-history (DEPRECATED)

Source: https://docs.prodegeads.com/publisher-apis/user-based-api-v1/get-offer-history-deprecated

Retrieves the offer history for a specific user. This endpoint is deprecated. Please use the 'Get History' endpoint with the 'offer_ids' filter instead.

```APIDOC
## GET /v1/user-based-api/offer-history

### Description
Retrieves the offer history for a specific user. This endpoint is deprecated and will no longer be updated. It is recommended to use the "Get History" endpoint with the `offer_ids` filter instead.

### Method
GET

### Endpoint
https://api.adgatemedia.com/v1/user-based-api/offer-history

### Parameters
#### Query Parameters
- **aff_id** (Integer) - Required - Your affiliate ID.
- **api_key** (String) - Required - Your API key.
- **wall_code** (String) - Required - Wall code that can be found on the AdGate Rewards page.
- **user_id** (String) - Required - The affiliate's user ID. Max length 255 bytes.
- **offer_id** (Integer) - Required - The ID of the offer.
- **lang** (String) - Optional - The language as provided by the browser (from `Accept-Language` HTTP header). Defaults to English if not provided.

### Request Example
```
GET https://api.adgatemedia.com/v1/user-based-api/offer-history?aff_id=60000&api_key=941bd1fecf7e6596823b895e04df3a0c&wall_code=nQug&user_id=user12345&offer_id=12345&lang=en-US
```

### Response
#### Success Response (200)
- **status** (String) - Indicates the status of the request.
- **data** (Array) - An array of offer history objects.
  - **offer_id** (Integer) - The ID of the offer.
  - **offer_name** (String) - The name of the offer.
  - **status** (String) - The status of the offer.
  - **date_completed** (String) - The date the offer was completed.

#### Response Example
```json
{
  "status": "success",
  "data": [
    {
      "offer_id": 12345,
      "offer_name": "Example Offer",
      "status": "completed",
      "date_completed": "2023-10-27 10:00:00"
    }
  ]
}
```
```

--------------------------------

### User Based API (v1) - Get Offer History (DEPRECATED)

Source: https://docs.prodegeads.com/publisher-apis

API endpoint to fetch historical details for a specific offer. Use it to get the status of each offer event. This endpoint is deprecated.

```APIDOC
## GET /publisher-apis/user-based-api-v1/get-offer-history-deprecated

### Description
Fetches historical details for a specific offer and its events. **This endpoint is deprecated.**

### Method
GET

### Endpoint
/publisher-apis/user-based-api-v1/get-offer-history-deprecated

### Parameters
#### Query Parameters
- **userId** (string) - Required - The unique identifier for the user.
- **offerId** (string) - Required - The unique identifier for the offer.

### Request Example
```
GET /publisher-apis/user-based-api-v1/get-offer-history-deprecated?userId=some_user_id&offerId=offer_123
```

### Response
#### Success Response (200)
- **history** (array) - A list of historical events for the offer.
  - **status** (string) - The status of the offer event.
  - **timestamp** (string) - The timestamp of the event.

#### Response Example
```json
{
  "history": [
    {
      "status": "started",
      "timestamp": "2023-10-27T09:00:00Z"
    }
  ]
}
```
```
Tokens:
Raw