Search
K
Kroger Ad Platform API

Jwt Endpoint

This endpoint will return your JWT.

get
https://api.8451.com/kap/v2/jwt

Response

200 application/json

Successful Response

get/jwt
 
200 application/json

Jwt Claim Reading Endpoint

This endpoint will show what claims your JWT has.

get
https://api.8451.com/kap/v2/jwt/claims

Response

200 application/json

Successful Response

get/jwt/claims
 
200 application/json

Account

object
idinteger

Account ID number.

Default:

namestring

Name of the Account.

Default:

activeboolean

Is the Account active, True/False.

Default:true

Example

AccountResponse

object
dataarray[object]required

List of Accounts.

Show Child Parameters
metaobjectrequired
Show Child Parameters
Example

AdGroup

object
adGroupIdAny Of

Id that identified the Ad Group.

Variant 1integer
campaignIdAny Of

The campaign id associated with this ad group.

Variant 1integer
nameAny Of

The ad group name.

Variant 1string
startDateAny Of

The start date of the ad group.

Default:

Variant 1string
endDateAny Of

The end date of the ad group. If null the ad group is considered ‘always-on’ and will stop when/if the campaign has an end date.

Variant 1string
budgetTypeAny Of

The type of budget.

BudgetTypestring

Allowed values:DAILYWEEKLYMONTHLYLIFETIME

budgetAmountAny Of

The budget of the ad group. The sum of all the budgets from the ad group(s) may not exceed the campaign budget.

Variant 1number
statusAny Of

The status of the ad group.

Variant 1string
baseBidAny Of

The base bid used for all entities that have the useBaseBid flag as true. It must be above the highers floor price of the placement(s) selected.

Variant 1number
entitiesarray[object]required

The products to be advertised.

Show Child Parameters
targetsarray[object]required

The target dimensions for this ad group. Includes placements, divisions, and day parting.

Show Child Parameters
keywordBidModifiersAny Of

Adjustments to keyword bids.

KeywordBidModifierarray[object]
Show Child Parameters
isArchivedAny Of

Whether this ad group is archived.

Variant 1boolean
Example