Commission Detail API: Advertiser Reference

This page covers the advertiserCommissions query and all advertiser-specific objects returned by the Commission Detail API.

Query: `advertiserCommissions`

Returns: AdvertiserCommissions!

Returns a list of commissions for the specified advertisers, filtered by the supplied arguments.

Argument	Type	Description
`forAdvertisers`	`[String!]!`	Required. List of advertiser company IDs (CIDs). Returns only commissions associated with the specified advertisers.
`actionStatuses`	`[String!]`	List of action statuses. Returns only commissions with one of these statuses.
`actionTypes`	`[String!]`	List of action types. Returns only commissions with one of these action types.
`adIds`	`[String!]`	List of unique ad IDs. Returns only commissions associated with the specified ads.
`beforeEventDate`	`String`	Datetime in UTC ISO 8601 format (e.g. `1999-12-31T11:59:59Z`). Returns only commissions whose event date is less than this value.
`beforeLockingDate`	`String`	Datetime in UTC ISO 8601 format. Returns only commissions whose locking date is less than this value.
`beforePostingDate`	`String`	Datetime in UTC ISO 8601 format. Returns only commissions whose posting date is less than this value.
`commissionIds`	`[String!]`	List of unique commission IDs. Returns only the specified commissions.
`lockingMethods`	`[LockingMethod!]`	If present and not empty, returns only commissions with one of these locking methods.
`publisherIds`	`[String!]`	List of publisher company IDs. Returns only commissions associated with the specified publishers.
`sinceCommissionId`	`String`	Pagination cursor. Set to `maxCommissionId` from the previous call to retrieve the next page of results. Repeat until `payloadComplete` is `true`.
`sinceEventDate`	`String`	Datetime in UTC ISO 8601 format. Returns only commissions whose event date is >= this value.
`sinceLockingDate`	`String`	Datetime in UTC ISO 8601 format. Returns only commissions whose locking date is >= this value.
`sincePostingDate`	`String`	Datetime in UTC ISO 8601 format. Returns only commissions whose posting date is >= this value.
`validationStatuses`	`[ValidationStatus!]`	If present and not empty, returns only commissions with one of these validation statuses.
`websiteIds`	`[String!]`	List of unique website IDs. Returns only commissions associated with the specified websites.

Object: `AdvertiserCommissions`

The result wrapper returned by an advertiserCommissions query.

Field	Type	Description
`count`	`Int!`	The number of commissions returned.
`limit`	`Int!`	The maximum number of commissions supported by the query.
`maxCommissionId`	`String`	The unique ID of the final commission returned by this call. Use as the `sinceCommissionId` cursor for the next page.
`payloadComplete`	`Boolean!`	If `false`, use `maxCommissionId` as `sinceCommissionId` to retrieve the next batch.
`records`	`[AdvertiserCommission!]!`	The commission records returned by the query.

Object: `AdvertiserCommission`

A record of an advertiser commission event, potentially including items purchased and advertiser-supplied custom attributes.

Computed fields: items, situations, customPixel, verticalAttributes

Field	Type	Description
`actionStatus`	`ActionStatus!`	Status of the commission.
`actionTrackerId`	`String!`	Unique identifier of the advertiser-defined action associated with the commission.
`actionTrackerName`	`String!`	Name of the action (as specified by the advertiser).
`actionType`	`ActionType!`	Action type for the commission.
`adOwner`	`String`	CID of the advertiser the link was clicked through. Only applies to cross-correlated accounts.
`advCommissionAmountAdvCurrency`	`DecimalNumber`	Advertiser commission amount in the advertiser's currency. (Advertiser-only)
`advCommissionAmountUsd`	`DecimalNumber`	Advertiser commission amount in USD. (Advertiser-only)
`advertiserId`	`String!`	CID of the advertiser for this commission.
`advertiserName`	`String!`	Name of the advertiser for this commission.
`aid`	`String`	Ad identification number.
`cjFeeAdvCurrency`	`DecimalNumber`	CJ fee in the advertiser's currency. (Advertiser-only)
`cjFeeUsd`	`DecimalNumber`	CJ fee in USD. (Advertiser-only)
`clickDate`	`Instant`	Click date for the commission.
`clickReferringURL`	`String`	Click referring URL for the commission.
`commissionId`	`String!`	Commission identification number.
`concludingBrowser`	`String`	The browser the transaction concluded in.
`concludingDeviceName`	`String`	The device name the transaction concluded in.
`concludingDeviceType`	`String`	The device type the transaction concluded in.
`correctionReason`	`CorrectionReason`	If not an original transaction, the reason the transaction was corrected.
`country`	`String`	Country where the transaction occurred.
`coupon`	`String`	The coupon/voucher code used in the transaction.
`customPixel`	`AdvertiserVerticalAttributes`	Deprecated. Use `verticalAttributes`. Advertiser-supplied custom pixel attributes.
`eventDate`	`Instant!`	Event date for the commission in UTC.
`initiatingBrowser`	`String`	The browser the transaction initiated in.
`initiatingDeviceName`	`String`	The device name the transaction initiated in.
`initiatingDeviceType`	`String`	The device type the transaction initiated in.
`isCrossDevice`	`Boolean`	`true` if the transaction was attributed using cross-device tracking.
`items`	`[Item!]!`	The items associated with this commissionable action.
`lockingDate`	`Instant!`	Date on which the commission is locked for extending or correcting.
`lockingMethod`	`LockingMethod`	The locking method for the commission based on program terms.
`newToFile`	`Boolean`	Advertiser-defined. Indicates if the customer is new or existing to the advertiser. (Advertiser-only)
`orderDiscountAdvCurrency`	`DecimalNumber`	Discount associated with the order in the advertiser's currency.
`orderDiscountOrigCurrency`	`DecimalNumber`	Discount associated with the order in the original currency.
`orderDiscountPubCurrency`	`DecimalNumber`	Discount associated with the order in the publisher's currency.
`orderDiscountUsd`	`DecimalNumber`	Discount associated with the order in USD.
`orderId`	`String`	Advertiser-assigned identification number for the order.
`original`	`Boolean!`	`true` = original transaction; `false` = non-original or corrected transaction.
`originalActionId`	`String!`	ID used for correlation between the original and corrected transaction.
`postingDate`	`Instant!`	Date on which the commission is posted.
`pubCommissionAmountPubCurrency`	`DecimalNumber!`	Publisher commission amount in the publisher's currency.
`pubCommissionAmountUsd`	`DecimalNumber!`	Publisher commission amount in USD.
`publisherId`	`String!`	CID of the publisher for this commission.
`publisherName`	`String!`	Name of the publisher for this commission.
`reviewedStatus`	`String`	Indicates if an advertiser has reviewed a transaction.
`saleAmountAdvCurrency`	`DecimalNumber`	Sale amount in the advertiser's currency.
`saleAmountPubCurrency`	`DecimalNumber`	Sale amount in the publisher's currency.
`saleAmountUsd`	`DecimalNumber`	Sale amount in USD.
`siteToStoreOffer`	`String`	Displays the coupon code used; indicates it was a site-to-store offer transaction.
`situationDetails`	`[Situation!]!`	Indicates if situations were defined in the commissioning structure.
`situations`	`[String!]!`	Deprecated. Use `situationDetails`.
`source`	`String`	Source for the transaction.
`validationStatus`	`ValidationStatus`	The commission's validation status.
`verticalAttributes`	`AdvertiserVerticalAttributes`	Advertiser-supplied vertical attributes.
`websiteId`	`String`	Publisher website identification number.
`websiteName`	`String`	Publisher website name.

Object: `AdvertiserVerticalAttributes`

Advertiser-supplied vertical attributes that may accompany a commissionable event. Fields marked (Advertiser-only) are not available in PublisherVerticalAttributes.

Computed fields: none

Field	Type	Description
`age`	`String`	Deprecated. Customer age or age-range.
`ancillarySpend`	`String`	The ancillary spend amount for the transaction. (Advertiser-only)
`annualFee`	`String`	Annual fee associated with this product.
`applicationStatus`	`String`	Status of the application at the time the transaction is sent to CJ.
`apr`	`String`	APR at time of application approval.
`aprTransfer`	`String`	APR for transfers.
`aprTransferTime`	`String`	APR transfer period in months.
`bookingDate`	`String`	Date the booking was made; `YYYY-MM-DD`.
`bookingStatus`	`String`	Status of the booking (e.g. confirmed, pending).
`bookingValuePostTax`	`String`	Value of booking after taxes.
`bookingValuePreTax`	`String`	Value of booking before taxes.
`brand`	`String`	Brand of item(s) purchased.
`brandId`	`String`	Identifier of the brand of the item booked.
`businessUnit`	`String`	Identifies the business unit the customer purchased through.
`campaignId`	`String`	Marketing Campaign ID; advertiser-specific.
`campaignName`	`String`	Marketing Campaign name; advertiser-specific.
`carOptions`	`String`	Whether other car option items were chosen (e.g. insurance).
`cardCategory`	`String`	Name of the card category.
`cashAdvanceFee`	`String`	Cash advance fee associated with this product.
`category`	`String`	Category of item (e.g. for a Personal Cash-back Credit Card: `service_type=cc&item_type=personal&category=cashback`).
`city`	`String`	Location city name (e.g. for a hotel or event).
`class`	`String`	Class rating of item booked/purchased.
`confirmationNumber`	`String`	Confirmation number from the provider (e.g. a flight confirmation number from the airline).
`contractLength`	`String`	Contract length in months.
`contractType`	`String`	Contract description; advertiser-specific.
`countryCode`	`String`	Country where the transaction occurred.
`couponDiscount`	`String`	Amount discounted from the coupon used.
`couponType`	`String`	Indicates the coupon type.
`creditLine`	`String`	Amount of credit extended.
`creditQuality`	`String`	Quality of customer's credit (300–579=Very Poor, 580–669=Fair, 670–739=Good, 740–799=Very Good, 800–850=Exceptional).
`creditReport`	`String`	Whether the customer received a credit report, purchased it, got a free report, or started a trial for a reporting service.
`cruiseType`	`String`	Type of cruise (e.g. Alaskan, Caribbean).
`custCountry`	`String`	Country of the purchasing customer per ISO 3166-1 alpha-2 (e.g. US, UK, AU, FR).
`custPostCode`	`String`	Deprecated. Postal code where customer is requesting service.
`custSegment`	`String`	Advertiser-specific customer segment definition.
`custStatus`	`String`	Defines if a customer is new or existing.
`custType`	`String`	Customer type (e.g. company, individual consumer, business, leisure).
`customerLocation`	`String`	Country of the purchasing customer per ISO 3166-1 alpha-3.
`delivery`	`String`	Method of delivery.
`description`	`String`	Product or card description.
`destCity`	`String`	The service destination city name (e.g. New York).
`destCountry`	`String`	The service destination country code per ISO 3166-1 alpha-2 (e.g. US, UK, AU, FR).
`destState`	`String`	The service destination state/province code per ISO 3166 standards.
`destinationId`	`String`	The service destination ID, typically an advertiser-defined code for a destination city or state (e.g. 728660).
`domestic`	`String`	Whether the customer resides in the US: `yes` or `no`.
`dropoffIata`	`String`	IATA code for the dropoff location if at an airport.
`dropoffId`	`String`	Unique car rental agency ID for the dropoff location.
`duration`	`String`	Duration in days (e.g. number of nights for a hotel stay; length of a trial).
`endDateTime`	`String`	Check-out date/time, departure date/time, etc.
`flightFareType`	`String`	Type of flight fare (e.g. gotta get away).
`flightOptions`	`String`	Whether other flight items were chosen (e.g. wifi).
`flightType`	`String`	Type of flight (e.g. direct, layover, overnight).
`flyerMiles`	`String`	Whether flyer miles were earned from this flight.
`fundedAmount`	`String`	Amount of account funding.
`fundedCurrency`	`String`	Currency for the account's initial funding.
`genre`	`String`	Entertainment category or genre (books, movies, streaming, music, etc.); transaction-level only.
`guests`	`String`	Number of guests.
`iata`	`String`	Code for each city in a flight schedule; comma-separated. Commas must be URL-encoded.
`introductoryApr`	`String`	The intro APR for purchases. If the intro APR is not different from the overall APR, use the `apr` parameter.
`introductoryAprTime`	`String`	Introductory APR period in months.
`itemId`	`String`	ID(s) of item(s) purchased. Multiple items: comma-separated list.
`itemName`	`String`	Name of the item purchased.
`itemType`	`String`	Type of item (e.g. `service_type=cc&item_type=personal&category=cashback`).
`itineraryId`	`String`	Booking itinerary ID.
`lifestage`	`String`	General demographic indicating how and why a card will be used (e.g. new mover, student, small business).
`location`	`String`	Store or location the customer will visit or has visited; advertiser-specific ID or name.
`loyaltyEarned`	`String`	Indicates the level of the customer's loyalty status.
`loyaltyFirstTimeSignup`	`String`	Indicates whether this order resulted in the consumer joining the loyalty program.
`loyaltyLevel`	`String`	Indicates if loyalty points were used.
`loyaltyRedeemed`	`String`	Indicates if loyalty points were earned.
`loyaltyStatus`	`String`	Customer's membership status.
`margin`	`String`	The profit margin for the transaction. (Advertiser-only)
`marketingChannel`	`String`	Marketing channel through which the customer was acquired; advertiser-specific.
`minBalance`	`String`	Value of the minimum cash balance requirement for the account.
`minDeposit`	`String`	Minimum deposit amount.
`minStayDuration`	`String`	Minimum stay duration required, in days.
`noCancellation`	`String`	`yes` = "no cancellation allowed" policy applied to this transaction.
`orCity`	`String`	The service origin city name (e.g. New York).
`orCountry`	`String`	The service origin country code per ISO 3166-1 alpha-2 (e.g. US, UK, AU, FR).
`orState`	`String`	The service origin state/province code per ISO 3166 standards.
`paidAtBookingPostTax`	`String`	Amount paid at booking after taxes.
`paidAtBookingPreTax`	`String`	Amount paid at booking before taxes.
`paymentMethod`	`String`	Method of payment used (e.g. credit card, Mastercard, PayPal, wire transfer).
`paymentModel`	`String`	Model of payment used; advertiser-specific.
`pickupIata`	`String`	IATA code for the pickup location if at an airport.
`pickupId`	`String`	Unique car rental agency ID for the pickup location.
`platformId`	`String`	Device platform the customer is using (e.g. mobile, tablet).
`pointOfSale`	`String`	The point of sale of the customer.
`port`	`String`	Departure port city (e.g. for cruises).
`preorder`	`String`	Indicates if the purchase was made before the item was available for sale.
`prepaid`	`String`	Whether the customer prepaid on their transaction: `yes` or `no`.
`prequalify`	`String`	Indicates if the applicant was pre-qualified for the card.
`promotion`	`String`	Promotion applied (e.g. "summer sale").
`promotionAmount`	`String`	The numeric value associated with the promotion (e.g. if the promotion is $500 cash back, pass `promotion=dollars&promotion_amt=500`).
`promotionConditionThreshold`	`String`	Threshold needed in order to get the discount.
`promotionConditionType`	`String`	Types of promotional conditions.
`promotionEnds`	`String`	Promotion end time. ISO 8601: `yyyy-mm-ddThh24:mm:ss.sssZ`.
`promotionStarts`	`String`	Promotion start time. ISO 8601: `yyyy-mm-ddThh24:mm:ss.sssZ`.
`promotionType`	`String`	Indicates the promotion type.
`quantity`	`String`	Quantity for a given SKU; simple actions only. For item-based actions, use `QTYx`.
`rating`	`String`	Star rating of item booked/purchased.
`roomType`	`String`	Room type booked (e.g. for hotel or cruise).
`rooms`	`String`	Number of rooms booked.
`serviceType`	`String`	Type of financial service the customer signed up for or purchased.
`shipName`	`String`	Name of the cruise ship.
`startDateTime`	`String`	Check-in date/time, arrival date/time, etc.
`state`	`String`	State/province code per ISO 3166-2 standards (e.g. `US-AK` for Alaska, `TH-10` for Bangkok).
`subscriptionFee`	`String`	Cost of subscription fee when signing up for free trial.
`subscriptionLength`	`String`	Product duration (e.g. "indefinite", 1 month, 3 months, 6 months).
`taxAmount`	`String`	Amount of the tax.
`taxType`	`String`	Type of the tax.
`transferFee`	`String`	The transfer fee amount (e.g. for a credit card).
`travelType`	`String`	Type of travel being booked (air, car, activities, cruise, events, hotel, package, restaurants, travel guides, vacation rental, other).
`tripType`	`String`	Type of trip (e.g. one-way, round-trip, multi-city, round-trip + hotel).
`upsell`	`String`	Indicates if someone converted from a trial to a subscription.

Commission Detail API: Advertiser Reference

Query: advertiserCommissions

Object: AdvertiserCommissions

Object: AdvertiserCommission

Object: AdvertiserVerticalAttributes

Query: `advertiserCommissions`

Object: `AdvertiserCommissions`

Object: `AdvertiserCommission`

Object: `AdvertiserVerticalAttributes`