Skip to main content
POST
Search On-Hold Conversions
Returns conversions currently in on-hold status. On-hold conversions are pending review before being approved or rejected. Use filters to narrow the results by date range, offer, or affiliate. Pagination is controlled through the page and page_size query parameters, not the JSON request body. For example, ?page=2&page_size=100 returns the second page of 100 results. Limited to the prior 365 days and a maximum date range of one year.

Authorizations

X-Eflow-Api-Key
string
header
required

The Everflow API key generated from the Control Center > Security.

Query Parameters

page
integer
default:1

The page of results to retrieve.

Required range: x >= 1
page_size
integer
default:50

The number of results to return per page.

Required range: x >= 1

Body

application/json
from
string
required

Start date (format: YYYY-MM-DD or YYYY-MM-DD HH:mm:SS).

to
string
required

End date (format: YYYY-MM-DD or YYYY-MM-DD HH:mm:SS).

timezone_id
integer
required

Timezone ID for the report.

show_conversions
boolean
required

Include base on-hold conversion records.

show_events
boolean
required

Include post-conversion event records.

query
object

Optional filters and search terms to narrow results.

Response

200 - application/json
conversions
object[]
paging
object