All documentation
Documentation
POST /sdk/v1/campaign-creators/line-items/query
Returns the calculated payment items for specific campaign creators or for one
campaign. Each media item includes its URL and campaignCreatorMediaId.
All requests require X-Application-Id and X-Api-Key.
Choose creators
Send exactly one of:
campaignCreatorRecordIds: up to 500 campaign creator record IDs.campaignId: one campaign. You can also sendpageandlimit;limitdefaults to100and cannot exceed500.
Optional fields
startDateandendDate: an inclusiveYYYY-MM-DDpayment range. Send both or neither.includeNonPayable: include items that are not currently payable and the reason for each. Default:true.
Example request
curl -sS "$BASE_URL/sdk/v1/campaign-creators/line-items/query" \
-X POST \
-H "Content-Type: application/json" \
-H "X-Application-Id: $APP_ID" \
-H "X-Api-Key: $API_KEY" \
-d '{
"campaignCreatorRecordIds": ["CCR_123", "CCR_456"],
"startDate": "2026-07-01",
"endDate": "2026-07-31",
"includeNonPayable": true
}'
To read a campaign one page at a time, use this body instead:
{
"campaignId": "camp_123",
"page": 1,
"limit": 500,
"startDate": "2026-07-01",
"endDate": "2026-07-31"
}
Response
{
"success": true,
"data": [
{
"campaignId": "camp_123",
"campaignName": "Summer launch",
"campaignCreatorRecordId": "CCR_123",
"creatorProfileId": "CP_123",
"creatorEmail": "jordan@example.com",
"effectiveTimeZone": "America/New_York",
"dateRange": {
"startDate": "2026-07-01",
"endDate": "2026-07-31"
},
"currency": "USD",
"totalAmount": 550,
"paymentBreakdown": {
"fixed": 300,
"cpm": 250,
"bonus": 0,
"total": 550
},
"lineItems": [
{
"campaignCreatorMediaId": "CCMEDIA_123",
"url": "https://www.tiktok.com/@jordan/video/123",
"platform": "TIKTOK",
"uploadedAt": "2026-07-08",
"eligibleOn": "2026-07-08",
"crosspostGroupKey": null,
"paymentType": "CPM",
"amount": 250,
"currency": "USD",
"payable": true
},
{
"campaignCreatorMediaId": "CCMEDIA_456",
"url": "https://www.instagram.com/p/example/",
"platform": "INSTAGRAM",
"uploadedAt": "2026-07-10",
"eligibleOn": "2026-07-10",
"crosspostGroupKey": null,
"paymentType": "BONUS",
"amount": 0,
"currency": "USD",
"payable": false,
"reason": "The post has not reached a bonus tier."
}
]
}
],
"failures": [],
"pagination": {
"page": 1,
"limit": 2,
"total": 2,
"totalPages": 1
}
}
Each result includes the campaign's effectiveTimeZone, resolved from the
campaign override, agency fallback, or UTC. The dateRange and media
business dates should be interpreted in that IANA timezone.
Every line item includes these three fields, including BONUS items and
non-payable items:
| Field | Meaning |
|---|---|
uploadedAt |
The post's canonical upload business date, in YYYY-MM-DD format, using the same stored date as fixed payments. null when no post or upload date applies. |
eligibleOn |
The calculated timing eligibility date, in YYYY-MM-DD format. For media items, this is the upload business date for NOW and NOW_AND_STOP, or the tracking completion date for CAMPAIGN_COMPLETION. Fixed per-post payments use the upload business date. null when the calculation has no applicable date. |
crosspostGroupKey |
The post's current crosspost group key, matching the payout report data. null for ungrouped posts or items with no single group. |
Media-backed BONUS items also include platform. Creator-level payments
can cover multiple posts and therefore have no single upload date or platform.
Canonical upload dates are preserved as calendar dates; tracking-completion
timestamps are converted to the campaign's effectiveTimeZone.
eligibleOn describes contract timing, not when a bonus threshold was reached
or when funds were sent. Other requirements can still make an item non-payable;
use payable and reason for its current status. For completion-based payments
without a configured tracking window, the calculation falls back to the upload
date. Crosspost groups and creator-level aggregates use the date selected by
the payout calculation, which can differ from the displayed post's own date.
An unknown or inaccessible creator, a creator whose requested endDate
predates their first contract terms, or a creator with a payout item that
predates those terms is returned in failures without stopping the rest of
the request. The failure reason distinguishes the requested-date and
payout-item cases.
Common errors
400: invalid selector, more than 500 creators, or incomplete date range401: missing or invalid SDK credentials404: selected campaign not found
