Swaarm

Retrieve conversion data for a publisher within a specified date range. This endpoint allows publishers to access their conversion statistics including payouts, event details, and approval status.

You can retrieve a list of publisher conversions by making a <code>GET</code> request to <code>/publisher-conversions</code>.

GET /publisher-conversions?apiKey=your-api-key&amp;start=2024-01-01T00:00:00&amp;end=2024-01-31T23:59:59

The response contains a list of conversion data within the specified date range.

{ "rows": [ { "time": "2024-01-15T14:30:00", "clickId": "click_12345", "offerId": "offer123", "eventId": "event456", "eventName": "Purchase", "subId": "sub_789", "payout": 25.50, "status": "APPROVED" } ] }

Date parameters (<code>start</code> and <code>end</code>) should be provided in ISO format (e.g., <code>2024-01-01T00:00:00</code>)

The <code>end</code> date is inclusive but adjusted to exclude the final second for precise range filtering

When <code>offerId</code> is provided, results are filtered to show only conversions for that specific offer

Payout amounts are returned in USD as decimal values

The API key is matched case-insensitively against stored publisher keys

Conversion data is typically available for up to 90 days. Older data may not be accessible through this endpoint

- Date parameters (<code>start</code> and <code>end</code>) should be provided in ISO format (e.g., <code>2024-01-01T00:00:00</code>)
- The <code>end</code> date is inclusive but adjusted to exclude the final second for precise range filtering
- When <code>offerId</code> is provided, results are filtered to show only conversions for that specific offer
- Payout amounts are returned in USD as decimal values
- The API key is matched case-insensitively against stored publisher keys
- Conversion data is typically available for up to 90 days. Older data may not be accessible through this endpoint

Retrieve conversion data for a publishers using a simple API

Publisher Conversions API

Connect with Swaarm

Find answers and get help from Intercom Support and Community Experts

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Link, Press control-option-right-arrow to exit

Empty Help Center

Uh oh. That page doesn’t exist.

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.

Parameter	Type	Required	Description
`apiKey`	string	Yes	Publisher API key for authentication
`start`	string	Yes	Start date for the conversion data range (ISO format)
`end`	string	Yes	End date for the conversion data range (ISO format)
`offerId`	string	No	Optional filter to retrieve conversions for a specific offer

Attribute	Type	Description
`rows`	array	Array of conversion data rows
`rows[].time`	string	Timestamp when the conversion occurred (ISO format)
`rows[].clickId`	string	Unique identifier for the click that led to this conversion
`rows[].offerId`	string	Identifier of the offer associated with the conversion
`rows[].eventId`	string	Identifier of the event type
`rows[].eventName`	string	Human-readable name of the event type
`rows[].subId`	string	Publisher's sub-identifier for tracking
`rows[].payout`	number	Payout amount in USD
`rows[].status`	string	Conversion status - `APPROVED`, `PENDING`, or `REJECTED`

Code	Description
200	Success - Returns conversion data
400	Bad Request - Invalid date format or missing required parameters
403	Forbidden - Invalid or missing API key

Publisher Conversions API

List publisher conversions

Parameters

Request

Response

Response body

HTTP status codes

Usage notes