Search transactions with Searchkick-backed filters
GET /transactions
GET /transactions
Operation
GET
/transactions
Searchkick transaction search with date presets, amount/rate ranges, and offset pagination. When no explicit dates are provided, defaults to the preceding 30 days (`transaction_date_preset=last_30_days`). GraphQL alternative: POST /graphql (`transactions` / `transaction`) via operationId executeGraphql — requires an explicit bound (advertiserId, publisherId, networkId, or both dates); no default 30-day window.
Operation ID:
searchTransactions
·
Tags: Transactions
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
q
|
query | No | string | Free-text query (transaction id, cid, advertiser/campaign name, etc.) |
query
|
query | No | string | Alias for q |
advertiser_id
|
query | No | object | Advertiser id filter (scalar, comma-list, or repeated) |
advertiser_slug
|
query | No | object | Advertiser slug filter |
network_id
|
query | No | object | Network id filter |
network_slug
|
query | No | object | Network slug filter |
publisher_id
|
query | No | object | Publisher id filter |
campaign_id
|
query | No | object | Campaign id filter |
cid
|
query | No | object | Network campaign/offer cid filter |
transaction_id
|
query | No | object | Network transaction id filter (not the Hi Energy numeric id) |
start_date
|
query | No | string | Inclusive transaction_date lower bound |
end_date
|
query | No | string | Inclusive transaction_date upper bound |
date_from
|
query | No | string | Alias for start_date |
date_to
|
query | No | string | Alias for end_date |
transaction_date_preset
|
query | No | string | Named transaction_date window; overridden by explicit start_date/end_date. Defaults to last_30_days when no dates are provided. |
period
|
query | No | string | Alias for transaction_date_preset |
date_preset
|
query | No | string | Alias for transaction_date_preset |
created_after
|
query | No | string | Filter on created_at lower bound |
created_before
|
query | No | string | Filter on created_at upper bound |
created_at_from
|
query | No | string | Alias for created_after |
created_at_to
|
query | No | string | Alias for created_before |
updated_after
|
query | No | string | Filter on updated_at lower bound |
updated_before
|
query | No | string | Filter on updated_at upper bound |
updated_at_from
|
query | No | string | Alias for updated_after |
updated_at_to
|
query | No | string | Alias for updated_before |
currency
|
query | No | object | Currency filter (ISO code) |
status
|
query | No | object | Normalized status filter (repeat or comma-separate for multiple) |
min_commission_amount_cents
|
query | No | integer | Minimum commission amount in cents |
max_commission_amount_cents
|
query | No | integer | Maximum commission amount in cents |
min_sale_amount_cents
|
query | No | integer | Minimum sale amount in cents |
max_sale_amount_cents
|
query | No | integer | Maximum sale amount in cents |
min_commission_rate
|
query | No | number | Minimum commission rate percentage |
max_commission_rate
|
query | No | number | Maximum commission rate percentage |
sort_by
|
query | No | string | Sort field |
sort_order
|
query | No | string | Sort direction |
limit
|
query | No | integer | Upper bound for per_page |
page
|
query | No | integer | Page number |
per_page
|
query | No | integer | Results per page |
include_total
|
query | No | boolean | Include exact total_count/total_pages in meta (capped at 100000) |
include_count
|
query | No | boolean | Alias for include_total |
cursor
|
query | No | string | Accepted for compatibility; live pagination uses page/per_page |
dry_run
|
query | No | boolean | Validate params without executing the search when supported |
Request Body
No request body is defined for this operation.
Responses
Content Types
application/json
{
"description": "Transactions list wrapped under `transactions` with offset pagination meta",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"transactions": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"example": "transaction"
},
"attributes": {
"$ref": "#/components/schemas/Transaction"
}
}
}
}
},
"required": [
"data"
]
},
"meta": {
"$ref": "#/components/schemas/TransactionsListMeta"
}
},
"required": [
"transactions",
"meta"
]
}
}
}
}{
"$ref": "#/components/responses/BadRequest"
}{
"$ref": "#/components/responses/Unauthorized"
}{
"$ref": "#/components/responses/RateLimited"
}API Playground
Run this GET request with your API key, or open it in a new tab. Path uses sample IDs where the OpenAPI path has {parameters}.
Sign in to enable live testing with your API key.
| Action | Method | Endpoint | Description |
|---|---|---|---|
| Search transactions with Searchkick-backed filters | GET |
/api/v1/transactions |
OpenAPI operationId: searchTransactions. |
GET /api/v1/transactions
OpenAPI
Search transactions with Searchkick-backed filters