Feed API API Reference

This API return all the offers for which you as a publisher are approved and have remaining budget for. Examples:

API Endpoint
https://feed.api.weq.com/v1.4
Terms of Service: https://weq.com/terms
Contact: api_sales@weq.com
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: http, https
Version: 1.4

Authentication

auth

in
query
name
api_key

Paths

ads

Ads Request

GET /ads

Returns all the offers on which you are approved

200 OK

Ads

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

Response Example (200 OK)
{
  "ads": [
    {
      "id": "string",
      "app_id": "string",
      "preview_url": "string",
      "offer_name": "string",
      "offer_description": "string",
      "app_title": "string",
      "app_description": "string",
      "app_rating": "string",
      "app_category": "string",
      "restrictions": "string",
      "targeting": {
        "countries": [
          "string"
        ],
        "os": {
          "platform": "string",
          "min_version": "string"
        }
      },
      "payout_type": "string",
      "payout": "number",
      "payout_currency": "string",
      "daily_leads": "integer",
      "daily_remaining_leads": "integer",
      "click_url": "string",
      "thumbs": [
        "string"
      ],
      "icons": {
        "72": "string",
        "96": "string",
        "128": "string",
        "256": "string"
      }
    }
  ]
}
Response Example (400 Bad Request)
{
  "errors": [
    {
      "reason": "Unauthorized",
      "message": "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "errors": [
    {
      "reason": "Unauthorized",
      "message": "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }
  ]
}
ads

Ads offer approval

GET /ads/:offerId/approval

Returns response http status code if offer is approved. 401 not approved, 202 approved.

202 Accepted

Offer is approved, request accepted

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized, or offer is not approved or does not have access

Response Example (400 Bad Request)
{
  "errors": [
    {
      "reason": "Unauthorized",
      "message": "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "errors": [
    {
      "reason": "Unauthorized",
      "message": "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }
  ]
}

Schema Definitions

AdsResponse: object

A response containing optimized ads

ads: object[]

The optimized ads

Example
{
  "ads": [
    {
      "id": "string",
      "app_id": "string",
      "preview_url": "string",
      "offer_name": "string",
      "offer_description": "string",
      "app_title": "string",
      "app_description": "string",
      "app_rating": "string",
      "app_category": "string",
      "restrictions": "string",
      "targeting": {
        "countries": [
          "string"
        ],
        "os": {
          "platform": "string",
          "min_version": "string"
        }
      },
      "payout_type": "string",
      "payout": "number",
      "payout_currency": "string",
      "daily_leads": "integer",
      "daily_remaining_leads": "integer",
      "click_url": "string",
      "thumbs": [
        "string"
      ],
      "icons": {
        "72": "string",
        "96": "string",
        "128": "string",
        "256": "string"
      }
    }
  ]
}

Ad: object

A single ad

id: string

The offer ID

app_id: string

The ID of the app on the AppStore/PlayStore

preview_url: string

The url of the offer preview

offer_name: string

The name of the offer

offer_description: string

A short description of the offer

app_title: string

The title of the mobile app this offer is for

app_description: string

A description of the mobile app

app_rating: string

The rating of the app in the Google Play Store or Apple App Store

app_category: string

The main category the app is in

restrictions: string

Guideline on which places the offer can be served

targeting: Targeting
payout_type: string

The type of the payout that will be paid

payout: number

The total payout for this offer

payout_currency: string

The currency this offer will be paid out in

daily_leads: integer

The total number of leads for this offer

daily_remaining_leads: integer

How many leads are remaining for the current day

click_url: string

The click URL

thumbs: string[]

Preview thumbnails for the app

icons: Icons
Example
{
  "id": "string",
  "app_id": "string",
  "preview_url": "string",
  "offer_name": "string",
  "offer_description": "string",
  "app_title": "string",
  "app_description": "string",
  "app_rating": "string",
  "app_category": "string",
  "restrictions": "string",
  "targeting": {
    "countries": [
      "string"
    ],
    "os": {
      "platform": "string",
      "min_version": "string"
    }
  },
  "payout_type": "string",
  "payout": "number",
  "payout_currency": "string",
  "daily_leads": "integer",
  "daily_remaining_leads": "integer",
  "click_url": "string",
  "thumbs": [
    "string"
  ],
  "icons": {
    "72": "string",
    "96": "string",
    "128": "string",
    "256": "string"
  }
}

Targeting: object

Device targeting for an offer

countries: string[]

Countries to whom the offer should be served to

os: OperatingSystem
Example
{
  "countries": [
    "string"
  ],
  "os": {
    "platform": "string",
    "min_version": "string"
  }
}

OperatingSystem: object

An operating system that should be targeted

platform: string

The platform that should be targeted

min_version: string

The minimum version of the operating system that should be targeted

Example
{
  "platform": "string",
  "min_version": "string"
}

Icons: object

Icons for an app

72: string

The URL to the app at 72px x 72px

96: string

The URL to the app at 72px x 72px

128: string

The URL to the app at 72px x 72px

256: string

The URL to the app at 72px x 72px

Example
{
  "72": "string",
  "96": "string",
  "128": "string",
  "256": "string"
}

ErrorResponse: object

An error thrown by the API

errors: object[]

An array of errors thrown by the API

Example
{
  "errors": [
    {
      "reason": "Unauthorized",
      "message": "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }
  ]
}

Error: object

A single API error

reason: string

A reason code for the error

message: string

A descriptive message of what caused the error

Example
{
  "reason": "Unauthorized",
  "message": "The request has not been applied because it lacks valid authentication credentials for the target resource"
}