Get Syndicated Offers

GET 
/v1/syndication

The Offer Syndication API allows a partner to pull offers and display them natively. This Static API returns all offers available to the partner based on the provided configId and apiKey.

This API is expected to be called periodically (recommended is every 5 minutes) to ensure that the offers being served are still relevant. If offers are removed they'll no longer be returned in the response and it is expected that the partner will remove the offer from their site. This could happen because the offer has capped, the offer has been paused, or the offer has been removed from the Fluent platform.

When a partner receives the offers, the tracking URL will require manipulation when rendered. There are two parameters that need to be replaced. The {userId} and {uniqueOfferId}. The {userId} is a user identifier that will be returned during partner postbacks. When a partner is doing internal testing, a partner should provide a fluentTest_ prefix to flag the user as a test user. The {uniqueOfferId} is a randomly generated globally unique id to uniquely tie a click to any converts that will be returned in postbacks.

Parameter Name	Description	Example
{userId}	This needs to be a user identifier. Will be returned during partner postbacks. When a partner is doing internal testing, a partner should provide a fluentTest_ prefix to flag the user as a test user.	Real Example: 123456 or Test Example: fluentTest_123456
{uniqueOfferId}	A randomly generated globally unique id to uniquely identify a click that will be returned in postbacks.	Example: cbb12252-e88c-4f75-89ea-5e31fb272e07

Request

Query Parameters

configId stringrequired

Config ID provided to you by Fluent

apiKey stringrequired

Api Key provided to you by Fluent

Responses

200

application/json

Schema

Schema

• Array [
campaignId string

The unique identifier for the campaign configuration.

campaignName string

The name of the offer campaign

campaignGroupId string

The unique identifier for the campaign targeting bucket

trackingUrl string

The URL for tracking and redirecting to the offer. There are values that need to be replaced by the partner. See the table at the top of the page

thumbnailUrl stringnullable

The URL of the thumbnail image for the offer.

title stringnullable

The main text displayed to the user about the offer.

description stringnullable

Additional details about the offer.

callToAction stringnullable

The call-to-action text for the offer.

disclaimer stringnullable

Disclaimer text associated with the offer.

payout double

The payout amount in USD for a successful conversion.

states object
Specifies location-based filtering for an offer.
include object[]
Locations to include in the filtering criteria.
Array [
locationName string
The name of the location (e.g., Toronto, Texas, United States).
countryCode string
The country code associated with the location (e.g., "US" for United States).
geoNameId int32
The GeoName id for this location provided by https://www.geonames.org/
]
exclude object[]
Locations to exclude from the filtering criteria.
Array [
locationName string
The name of the location (e.g., Toronto, Texas, United States).
countryCode string
The country code associated with the location (e.g., "US" for United States).
geoNameId int32
The GeoName id for this location provided by https://www.geonames.org/
]
countries object
Specifies location-based filtering for an offer.
include object[]
Locations to include in the filtering criteria.
Array [
locationName string
The name of the location (e.g., Toronto, Texas, United States).
countryCode string
The country code associated with the location (e.g., "US" for United States).
geoNameId int32
The GeoName id for this location provided by https://www.geonames.org/
]
exclude object[]
Locations to exclude from the filtering criteria.
Array [
locationName string
The name of the location (e.g., Toronto, Texas, United States).
countryCode string
The country code associated with the location (e.g., "US" for United States).
geoNameId int32
The GeoName id for this location provided by https://www.geonames.org/
]
cities object
Specifies location-based filtering for an offer.
include object[]
Locations to include in the filtering criteria.
Array [
locationName string
The name of the location (e.g., Toronto, Texas, United States).
countryCode string
The country code associated with the location (e.g., "US" for United States).
geoNameId int32
The GeoName id for this location provided by https://www.geonames.org/
]
exclude object[]
Locations to exclude from the filtering criteria.
Array [
locationName string
The name of the location (e.g., Toronto, Texas, United States).
countryCode string
The country code associated with the location (e.g., "US" for United States).
geoNameId int32
The GeoName id for this location provided by https://www.geonames.org/
]
platforms object

Specifies platform and version eligibility

android boolean

Indicates whether the offer is eligible for Android devices.

ios boolean

Indicates whether the offer is eligible for iOS devices.

web boolean

Indicates whether the offer is eligible for Web platforms.

androidMinVersion stringnullable

The minimum version for Android devices. This property defines the lowest version of Android that the offer supports.

androidMaxVersion stringnullable

The maximum version for Android devices. This property defines the highest version of Android that the offer supports.

iosMinVersion stringnullable

The minimum version for iOS devices. This property defines the lowest version of iOS that the offer supports.

iosMaxVersion stringnullable

The maximum version for iOS devices. This property defines the highest version of iOS that the offer supports.

Example (from schema)

[
  {
    "campaignId": "string",
    "campaignName": "string",
    "adGroupId": "string",
    "creativeId": "string",
    "trackingUrl": "string",
    "thumbnailUrl": "string",
    "title": "string",
    "description": "string",
    "callToAction": "string",
    "timeToComplete": "string",
    "disclaimer": "string",
    "payout": 0,
    "states": {
      "include": [
        {
          "locationName": "string",
          "countryCode": "string",
          "geoNameId": 0
        }
      ],
      "exclude": [
        {
          "locationName": "string",
          "countryCode": "string",
          "geoNameId": 0
        }
      ]
    },
    "countries": {
      "include": [
        {
          "locationName": "string",
          "countryCode": "string",
          "geoNameId": 0
        }
      ],
      "exclude": [
        {
          "locationName": "string",
          "countryCode": "string",
          "geoNameId": 0
        }
      ]
    },
    "cities": {
      "include": [
        {
          "locationName": "string",
          "countryCode": "string",
          "geoNameId": 0
        }
      ],
      "exclude": [
        {
          "locationName": "string",
          "countryCode": "string",
          "geoNameId": 0
        }
      ]
    },
    "platforms": {
      "android": true,
      "ios": true,
      "web": true,
      "androidMinVersion": "string",
      "androidMaxVersion": "string",
      "iosMinVersion": "string",
      "iosMaxVersion": "string"
    }
  }
]

204

No Content

401

Unauthorized

404

Not Found

500

Internal Server Error

Loading...