CAKE Basic API: Admin Technical Documentation

Ayça Miller

Modified on: Wed, 4 Feb, 2015 at 5:43 PM

This page houses all of the Admin API Resource links for utilizing the CAKE Basic Admin APIs. Clicking through to each API will give detailed descriptions and parameters for each call.

cupCAKE ADMIN API's

ADD

Resource	Description
ADD AdvertiserCredit	This API allows you to add additional advertiser credit to a specific advertiser
ADD Creative	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
ADDEDIT Affiliate	Allows to create or update an existing affiliate details in CAKE
ADDEDIT Contact	Allows to create or update an existing contact details in CAKE
ADDEDIT Campaign	Allows you to create or update campaign details in CAKE.
ADDEDIT Caps	Allows you to create or update Cap details for an offer/campaign in CAKE.
ADDEDIT Offer	Allows you to add or edit offers in CAKE.
ADDEDIT Vertical	Allows you to create or update Vertical in CAKE.

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.
BuyerContracts	Returns an array of buyer contracts and its properties.
Buyers	Returns and array of buyers and its properties.
Campaigns	Exports all campaigns potentially filtered by campaign, offer, affiliate, account status or media type.
Creatives	Returns an array of buyer creatives potentially filterd by creative_id, creative_name, offer_id and its properties.
Offers	Returns an array of offers potentially filterd by offer id, offer name, advertiser id, vertical id, offer type id, media type id, offer status id or tag id.
RulesTargets	Returns rules targets.
Schedules	Returns an array of buyers and its properties.

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.
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.
ExchangeRates	Returns an array of exchange rates.
GetAPIKey	Returns the API Key Value.
Languages	Returns an array of languages.
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.
Verticals	Returns an array of verticals.

SIGNUP

Resource	Description
Advertiser	Allows you to signup and advertiser from outside CAKE
Affiliate	Allows you to sign up new affiliate from outside CAKE
GetMediaTypes	Returns an Array of Media Types.
GetPriceFormats	Returns an Array of Price Formats.
GetTrafficTypes	Returns an Array of Traffic Types
GetVerticalCategories	Returns an Array of Vertical Categories

REPORTS

Resource	Description
AffiliateSummary	Returns a summary of all campaigns ran by an affiliate during a certain period of time.
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.
ConversionChanges	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.
Conversions	Exports all conversion info filtered by campaign, affiliate offer, advertiser, or creative.
DailySummaryExport	Returns an array of the daily summary reports filterable by affiliate,advertiser,offer,vertical,campaign,creative and account manager.
LeadsByAffiliateExport	Returns an array of leads, potentially filtered by affiliate.
LeadsByBuyer	Returns an array of leads sorted by buyer properties
LoginExport	Returns an array of logins, potentially filtered by role.
TrafficExport	This API will return an array of traffic reports.

TRACK

Resource	Description
AcceptedDispositions	This API will return an array of accepted dispositions
ConversionDispositions	This API will return an array of conversion dispositions.
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 is designed to make adjustments to conversions that have already happened. This API will not create or delete conversions.
RejectedDispositions	This API will allow you to get the Rejected dispositions your instance of CAKE currently allows for.
UpdateConversionDisposition	Allows you to change the disposition of a single conversion.
UpdateConversionPrice	Returns a message indicating whether or not the conversion price was updated.
UpdateConversionRevenue	Enables the update of a specific conversion based upon a Request ID passed in.
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.