1. Offer
Target Circle API
  • Publisher API
    • Ads
      • List vouchers
    • Offers
      • List offers
    • Schemas
      • Transaction
        • TransactionType
      • Offer
        • OfferStatus
        • OfferReview
        • OfferFrequentlyAskedQuestion
        • OfferCategory
        • OfferVertical
        • OfferTracking
        • OfferTargetedCountry
        • OfferKpi
        • OfferPriceSegment
        • OfferDeviceGroup
        • Offer
        • OfferProductGroup
        • OfferAttributionModel
      • Voucher
      • TextLink
      • Banner
      • Link
      • Connection
      • PriceCombination
      • Image
      • Currency
      • Advertiser
      • Provider
      • Money
      • Error
      • KPI
  • Advertiser API
    • Using the API
      • Authorization
    • Login
      • Get token
      • Login
    • Performance
    • Transactions
      • Set transaction status to "pending"
      • Set transaction status to "declined"
      • Set transaction status to "approved"
    • Touchpoints
    • Offers
    • Ads
      • Bulk update text links
      • Bulk update banners
    • Trades
      • Bulk update trades
    • Schemas
      • Offer
        • OfferPriceSegment
        • OfferProductGroup
        • OfferStatus
        • OfferTracking
        • OfferTargetedCountry
        • OfferOverview
        • OfferCategory
        • OfferVertical
        • AttributionModel Filter
        • OfferStatus Filter
        • Offer
        • OfferAttributionModel
        • OfferFrequentlyAskedQuestion
        • OfferReview
      • Transaction
        • TransactionType
        • TransactionSourceCurrency
        • TransactionTrackingMethod
        • TransactionType Filter
        • TransactionOrderItem
      • Touchpoint
        • TouchpointStatus
        • TouchpointSummary
        • AttributionStatus Filter
        • TouchpointAttributionStatus
      • Job
      • Currency
      • Provider
      • Advertiser
      • Money
      • TradeType
      • TradeType Filter
      • AdType
      • AdType Filter
      • AdInventoryTrafficType
      • PriceCombination
      • KPI
      • Image
  • Provider API
    • Using the API
      • Naming Conventions
      • Authorization
      • Linking & Embedding
    • Offers
      • List offers
      • Create an offer
    • Trades
      • List trades
    • Schemas
      • Transaction
        • TransactionType
      • Offer
        • OfferVertical
        • OfferTargetedCountry
        • OfferPriceSegment
        • OfferDeviceGroup
        • Offer
        • OfferProgram
        • OfferCategory
        • GatewaySection
        • OfferProductGroup
        • OfferTracking
        • OfferStatus
        • OfferReview
        • OfferFrequentlyAskedQuestion
        • OfferAttributionModel
        • OfferProgramTerms
      • SignUpItem
      • Language
      • Connection
      • PriceCombination
      • SignInItem
      • Image
      • Currency
      • Platform
      • Advertiser
      • Provider
      • Money
      • AdInventoryTrafficType
      • Trade
      • TradeType
      • KPI
  1. Offer

Offer

{
    "sid": "abc123",
    "name": "Little Big Cloud",
    "logo": {
        "url": "string"
    },
    "url": "string",
    "description": "string",
    "vertical": {
        "code": "finance",
        "name": "string"
    },
    "category": {
        "code": "string",
        "name": "string"
    },
    "provider": {
        "sid": "ghy789",
        "name": "Global Services"
    },
    "advertiser": {
        "sid": "def456",
        "name": "Cloud Corporation"
    },
    "accountManager": {
        "email": "string",
        "firstName": "string",
        "lastName": "string"
    },
    "ads": {
        "text": {
            "count": 0
        },
        "banner": {
            "count": 0
        },
        "voucher": {
            "count": 0
        },
        "productFeed": {
            "count": 0
        },
        "richMedia": {
            "count": 0
        }
    },
    "defaultTargetUrl": "string",
    "attributionModel": {
        "code": "lastClick",
        "name": "string"
    },
    "targetedCountries": [
        {
            "code": "DE",
            "name": "Germany"
        }
    ],
    "tracking": {
        "deeplinking": {
            "isEnabled": true
        },
        "customTrackingDomain": {
            "isEnabled": true
        },
        "productLevelTracking": {
            "isEnabled": true
        },
        "conversionPathAttribution": {
            "isEnabled": "string"
        },
        "cookieExpiration": 2592000,
        "fingerprintExpiration": 2592000,
        "impressionExpiration": 86400
    },
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "terms": {
        "content": "string",
        "attachment": {
            "url": "string"
        }
    },
    "kpis": {
        "averageApprovalRate": {
            "value": 0,
            "percentile": 0
        },
        "averagePayoutPerClick": {
            "amount": {
                "amount": 5.5,
                "currencyCode": "EUR"
            },
            "percentile": 0
        },
        "averagePayoutPerSale": {
            "amount": {
                "amount": 5.5,
                "currencyCode": "EUR"
            },
            "percentile": 0
        },
        "averagePayoutPerLead": {
            "amount": {
                "amount": 5.5,
                "currencyCode": "EUR"
            },
            "percentile": 0
        },
        "averageConversionRate": {
            "value": 0,
            "percentile": 0
        },
        "averagePaymentTime": {
            "value": 0,
            "percentile": 0
        }
    },
    "_links": {
        "x:reviews": {
            "href": "/api/v3/advertiser/offers/{sid}/reviews"
        },
        "x:frequentlyAskedQuestions": {
            "href": "/api/v3/advertiser/offers/{sid}/frequently-asked-questions"
        }
    },
    "_embedded": {
        "x:reviews": [
            {
                "id": "string",
                "rating": 0,
                "content": "string",
                "author": {
                    "firstName": "string",
                    "lastName": "string",
                    "avatar": {
                        "url": "string"
                    },
                    "title": "string"
                },
                "createdAt": "2019-08-24T14:15:22.123Z",
                "updatedAt": "2019-08-24T14:15:22.123Z"
            }
        ],
        "x:frequentlyAskedQuestions": [
            {
                "id": "string",
                "title": "Where can I view my affiliate earnings? ",
                "content": "string",
                "position": 0,
                "createdAt": "2019-08-24T14:15:22.123Z",
                "updatedAt": "2019-08-24T14:15:22.123Z"
            }
        ]
    }
}
Built with