This page houses all of the Admin API Resource links for utilizing the CAKE Admin APIs. Clicking through to each API will give detailed descriptions and parameters for each call.
ADMIN APIs
ACCOUNTING
| Resource | Description |
| ACCOUNTING ExportAdvertiserBills | This API allows you to export Advertiser bills |
| ACCOUNTING ExportAffiliateBills | This API allows you to export Affiliate bills |
| ACCOUNTING ExportBuyerBills | This API allows you to export Buyer bills |
| ACCOUNTING MarkAdvertiserBillsAsReceived | This API allows you to mark Advertiser bills as received |
| ACCOUNTING MarkAdvertiserBillSent | This API allows you to mark Advertiser bills as sent |
This API allows you to mark Affiliate bills as paid | |
| ACCOUNTING MarkAffiliateBillAsReceived | This API allows you to mark Affiliate bills as received |
| ACCOUNTING MarkBuyerBillAsReceived | This API allows you to mark Buyer bills as received |
| ACCOUNTING MarkBuyerBillAsSent | This API allows you to mark Buyer bills as sent |
ADD
| Resource | Description |
This API allows you to add additional credit to a specific advertiser | |
| ADD BuyerCredit | This API allows you to add additional credit to a specific buyer |
This API allows Creative entities to be allocated and an ID number assigned. Uploading of Creative media must be performed via the in-interface uploader; CAKE recommends using this API for Link Creatives ONLY | |
| ADD ManualCredit | This API allows you to add additional advertiser credit to a Buyer |
ADDEDIT
Resource | Description |
| ADDEDIT Advertiser | Allows to create or edit an advertiser in CAKE. |
| ADDEDIT AdvertiserCreditLimit | Allows to set or update an advertiser Credit Limit in CAKE. |
| Allows to create or update an existing affiliate details in CAKE. | |
| ADDEDIT ApplySchedule | Applies schedule in CAKE. |
| ADDEDIT ApplySuppressionListToOffer | Allows you to create or update a suppression list to an existing offer in CAKE. |
| ADDEDIT ApplySharedRulesToOfferContract | This API will assign rules to offer contracts via API. This version will support adding shared rules to offer contracts only. |
| ADDEDIT Blacklist | Allows you to add or edit an affiliate blacklist in CAKE. |
| ADDEDIT BrandAdvertiserEvent | Allows you to add or edit Events on the Advertiser Card |
| ADDEDIT Buyer | Allows creation and editing of Buyer entity in CAKE. |
| ADDEDIT BuyerContract | Allows creation and editing of a Buyer Contract entity in CAKE. |
| ADDEDIT BuyerContractFilter | Apply Buyer Contract filters in CAKE. |
| ADDEDIT BuyerContractCopyFilters | Allows the duplication of Buyer Contract filters in CAKE. |
| ADDEDIT BuyerContractHeaders | Allows to create or update an existing buyer contracts ping or post headers in CAKE. |
| ADDEDIT BuyerContractZipCodeFilter | Create and edit the zip code distance filter for a specific buyer contract in CAKE. |
| ADDEDIT BuyerContractDeliveryMethod | Allows configuration of the Delivery Method tab of the Buyer Contract Card in CAKE. |
| ADDEDIT BuyerContractDeliverySchedule | Allows configuration of the Delivery Schedule tab of the Buyer Contract in CAKE. |
| ADDEDIT Campaign | Allows you to create or update campaign details in CAKE. |
| ADDEDIT CampaignCreativeExceptions | Allows adding, and Editing Campaign level exceptions. Users can manage, Creative exceptions by specifying whether the inputs are blocked or allowed in CAKE. |
| ADDEDIT CampaignEvents | Allows you to add or edit Events on the Campaign Card |
| ADDEDIT CampaignSubIdExceptions | Allows adding, and Editing Campaign level exceptions. Users can manage, SubIds exceptions by specifying whether the inputs are blocked or allowed in CAKE. |
| ADDEDIT Caps | Allows you to create or update Cap details for an offer/campaign in CAKE. |
| ADDEDIT Contact | Allows to create or update an existing contact details in CAKE. |
| ADDEDIT Creative | Allows you to create or update Creative details for an offer in CAKE. |
| ADDEDIT CreativeFiles | Allows you to create or update CreativeFiles in CAKE. |
| ADDEDIT ExchangeRate | Allows you to create or update ExchangeRates in CAKE. |
| ADDEDIT GeoTargets | Allows you to create or update GeoTargets for an offer in CAKE. |
| ADDEDIT LeadSaleCaps | Create and edit lead sale caps for Buyers or Buyer Contracts in CAKE. |
| ADDEDIT Offer | Allows you to add or edit offers in CAKE. |
| ADDEDIT OfferContract | Allows you to create or update OfferContract in CAKE. |
| ADDEDIT RemoveBlacklist | Remove blacklists set in CAKE. |
| ADDEDIT SiteOfferEvents | Allows you to add and edit Events on the Offer Card |
| Allows you to create or update Suppression List in CAKE. | |
| ADDEDIT Vertical | Allows you to create or update Vertical in CAKE. |
AUTH
| Resource | Description |
| AUTH Login | Returns the "Success" true. Also returns "success_info" object with details about the authenticated user. |
EDIT
| Resource | Description |
| Buyer | Allows you to update Buyer account status and credit in CAKE. |
EXPORT
| Resource | Description |
| Advertisers | Returns an array of advertisers potentially filtered by advertiser ID, advertiser name, account manager ID, or Tag ID. |
| AffiliateReferrals | Returns an array of Affiliate Referrals. The start_at_row property defines how many records would be skipped before showing the first row (could be used for paging) and row_limit will define how many rows are displayed per call. |
| Affiliates | Returns an array of affiliates potentially filtered by affiliate id, affiliate name, account manager id or tag id. |
| Blacklists | Returns an array of blacklists potentially filtered by affiliate, subaffiliate, advertiser id, or offer id |
| BuyerContracts | Returns an array of buyer contracts and its properties filtered by status, vertical, or buyer |
| Buyers | Returns an array of buyers and its properties filtered by status |
| CampaignLeadTiers | Returns an array of campaign lead tiers filtered by campaign, offer, offer contract, affiliate, account status or media type. |
Exports all campaigns potentially filtered by campaign, offer, affiliate, account status or media type. | |
| Returns an array of creatives potentially filtered by creative_id, creative_name, offer_id and its properties. | |
| LeadTiers | Returns an array of lead tiers filtered |
Returns an array of offers potentially filtered by offer id, offer name, advertiser id, vertical id, offer type id, media type id, offer status id or tag id. | |
| PixelLogRequest | The pixel log displays all the pixel attempts made by your advertisers for any of your offers, active or inactive, for the purposes of better understanding how your advertisers have implemented your pixel(s). This API will allow you to call these logs for your record and review. |
| RulesTargets | Returns rules targets. |
| Schedules | Returns an array of buyers schedules |
GET
| Resource | Description |
| AccountStatuses | Returns an array of account statuses. |
| Advertisers | Returns an array of advertisers. |
| AffiliateTags | Returns an array of affiliate tags. |
| AffiliateTiers | Returns an array of affiliate tiers. |
| BillingCycles | Returns an array of billing cycles. |
| BlacklistReasons | Returns an array of blacklist reasons. |
| CapIntervals | Returns an array of cap intervals. |
| CapTypes | Returns an array of cap types. |
| Countries | Returns an array of countries. |
| Currencies | Returns an array of currencies. |
| Departments | Returns an array of departments. |
| EmailTemplates | Returns an array of email templates. |
| ExchangeRates | Returns an array of exchange rates. |
| FilterTypes | This API allows you to get ID’s and details for filter types in the system. |
| GetAPIKey | Returns the API Key Value. |
| InactiveReasons | Returns an array of inactive reasons. |
| Returns an array of languages. | |
| LeadInfo | Returns lead information for a single lead |
| LeadTierGroups | Returns an array of lead tier groups |
| LinkDisplayTypes | Returns an array of link display types |
| MediaTypes | Returns an array of media types. |
| OfferStatuses | Returns an array of offer statuses. |
| OfferTypes | Returns an array of offer types. |
| PaymentSettings | Returns an array of payment settings. |
| PaymentTypes | Returns an array of payment types. |
| PriceFormats | Returns an array of price formats. |
| ResponseDispositions | Returns an array of response dispositions. |
| Returns an array of roles. | |
| SessionRegenerationTypes | Returns an array of session regeneration types |
| SharedRules | Returns an array of shared rules |
| TrackingDomains | Returns an array of tracking domains. |
| Unpaid Disposition | Returns unpaid dispositions |
| Returns an array of verticals. |
REPORTS
| Resource | Description |
| AdvertiserSummary | Returns a summary of all traffic ran to an advertiser during a certain period of time. |
| Performance summary based on campaign. | |
| Caps | Returns a report on click and conversion caps set on entities and the progress towards those caps within the specified time frame. |
| Clicks | Exports all clicks info filtered by campaign, affiliate offer, advertiser, or creative. |
| CreativeSummary | Returns an array of conversion and their properties. |
| EventConversionChanges | This API will return a list of Conversions that have changed within a specific time period. This information can also be found in the Conversion Report. |
| EventConversions | Exports all conversion info filtered by campaign, affiliate offer, advertiser, or creative. |
| ConversionExport | Returns an array of conversions and its properties. |
| DailySummaryExport | Returns an array of the daily summary reports filterable by affiliate,advertiser,offer,vertical,campaign,creative and account manager. |
| LeadsByAffiliate | Returns an array of leads, potentially filtered by affiliate. |
| Returns an array of leads sorted by buyer properties | |
| Returns an array of logins, potentially filtered by role. | |
| OrderDetails | Returns an array of orders, potentially filtered by affiliate,conversion and order |
| PingPosts | This API would be built to extract the data from the Buyer Reports > Pings & Posts column. |
| This API will return an array of traffic reports. | |
| SourceAffiliateSummary | Returns a summary of all campaigns ran by an affiliate during a certain period of time. |
| Returns a performance summary for a given offer(s) |
SIGNUP
| Resource | Description |
| Advertiser | Allows you to signup and advertiser from outside CAKE |
| Affiliate | Allows you to sign up new affiliate from outside CAKE |
| Returns an Array of Media Types. | |
| Returns an Array of Price Formats. | |
| GetTrafficTypes | Returns an Array of Traffic Types |
| GetVerticalCategories | Returns an Array of Vertical Categories |
TRACK
| Resource | Description |
| AcceptedDispositions | This API will return an array of accepted dispositions |
| ConversionDispositions | This API will return an array of conversion dispositions. |
| DecryptAffiliateLink | Returns the information that was encrypted in the supplied link. |
| MassConversionAdjustment | This API is designed to make adjustments to conversions that have already happened. This API will not create or delete conversions. |
| MassConversionInsert | This API will allow you to add conversions into your instance. |
| RejectedDispositions | This API will allow you to get the Rejected dispositions your instance of CAKE currently allows for. |
| UpdateConversion | Returns a message indicating whether or not the conversion was updated. |
| UpdateSaleRevenue | Enables the update of revenue for a specific lead sale based upon a Lead ID passed in. |
| UpdateLeadPrice | Changing the price paid to an affiliate for a lead sold to a buyer. |
| UpdateLeadInQueue | This API is a multi-tasker, but will only control actions related to leads in pre-sale custom queues that are currently possible in the admin via the Call Center grid. |
| UpdateConversionRevenue | This API allows you to adjust/update the revenue on a conversion. |