Queries

The root query fields. Every request starts at one of these.

Argument behavior is shared across all of them — dates are Unix timestamps, sort accepts only a per-type list of fields, and first/last override sort. See Filtering and Sorting before building a query.

authenticate

Check that API Keys are working

Returns String.

affiliates

Returns a list of Client's Affiliates

Returns [Affiliate].

Argument	Type	Notes
id	ID	Returns only the record with this id.
status	String	Exact match. The returned type lists the values that can appear.
email	String	Exact match on the affiliate's email address.
created_from	Int	Unix timestamp in seconds. Exclusive — matches rows created strictly after it.
created_to	Int	Unix timestamp in seconds. Inclusive — matches rows created at or before it.
last_login_from	Int	Unix timestamp in seconds. Exclusive.
last_login_to	Int	Unix timestamp in seconds. Inclusive.
last_conversion_from	Int	Unix timestamp in seconds. Exclusive.
last_conversion_to	Int	Unix timestamp in seconds. Inclusive.
offer_id	Int	Returns only records tied to this offer.
updated_from	Int	Unix timestamp in seconds. Exclusive — matches rows updated strictly after it.
updated_to	Int	Unix timestamp in seconds. Inclusive — matches rows updated at or before it.
sort	String	Field to sort by, descending. Each type accepts its own short list — see Sorting on the returned type's page. Anything else is ignored without an error.
before	ID	Returns only rows with an id lower than this. Cursor-style paging.
after	ID	Returns only rows with an id higher than this. Cursor-style paging.
limit	Int	Rows to return. Anything outside 1–200 is replaced by 200.
offset	Int	Rows to skip before returning results.
first	Int	Acts as limit, but also forces sorting by id ascending and overrides any sort you pass.
last	Int	Acts as limit, but also forces sorting by id descending and overrides any sort you pass.

clicks

A list of clicks

Returns [Click].

Argument	Type	Notes
id	ID	Returns only the record with this id.
sub_id	ID	Matches the subid carried on the tracking link.
created_from	Int	Unix timestamp in seconds. Exclusive — matches rows created strictly after it.
created_to	Int	Unix timestamp in seconds. Inclusive — matches rows created at or before it.
affiliate_id	ID	Returns only records belonging to this affiliate.
offer_id	ID	Returns only records tied to this offer.
creative_id	ID	Returns only records tied to this creative.
sort	String	Field to sort by, descending. Each type accepts its own short list — see Sorting on the returned type's page. Anything else is ignored without an error.
limit	Int	Rows to return. Anything outside 1–200 is replaced by 200.
before	ID	Returns only rows with an id lower than this. Cursor-style paging.
after	ID	Returns only rows with an id higher than this. Cursor-style paging.
offset	Int	Rows to skip before returning results.
first	Int	Acts as limit, but also forces sorting by id ascending and overrides any sort you pass.
last	Int	Acts as limit, but also forces sorting by id descending and overrides any sort you pass.

conversions

A list of conversions

Returns [Conversion].

Argument	Type	Notes
id	ID	Returns only the record with this id.
status	String	Exact match. The returned type lists the values that can appear.
merchant_unique_id	String	Matches the order identifier you sent when reporting the order. Identical in effect to order_id.
payment_status	String	Pass UNPAID for conversions not yet in a payment. Any other value matches conversions that are already in one.
type	String	Exact match. The returned type lists the values that can appear.
created_from	Int	Unix timestamp in seconds. Exclusive — matches rows created strictly after it.
created_to	Int	Unix timestamp in seconds. Inclusive — matches rows created at or before it.
updated_from	Int	Unix timestamp in seconds. Exclusive — matches rows updated strictly after it.
updated_to	Int	Unix timestamp in seconds. Inclusive — matches rows updated at or before it.
is_test_conversion	Boolean	Pass true to return only test conversions, false for only real ones. Omit to return both.
affiliate_id	ID	Returns only records belonging to this affiliate.
offer_id	ID	Returns only records tied to this offer.
payment_id	ID	Returns only conversions included in this payment.
order_id	String	Matches the order identifier you sent when reporting the order. Identical in effect to merchant_unique_id.
sort	String	Field to sort by, descending. Each type accepts its own short list — see Sorting on the returned type's page. Anything else is ignored without an error.
limit	Int	Rows to return. Anything outside 1–200 is replaced by 200.
before	ID	Returns only rows with an id lower than this. Cursor-style paging.
after	ID	Returns only rows with an id higher than this. Cursor-style paging.
offset	Int	Rows to skip before returning results.
first	Int	Acts as limit, but also forces sorting by id ascending and overrides any sort you pass.
last	Int	Acts as limit, but also forces sorting by id descending and overrides any sort you pass.

conversion_triggers

A list of conversion triggers

Returns [ConversionTrigger].

Argument	Type	Notes
id	String	Returns only the record with this id.
status	String	Exact match. The returned type lists the values that can appear.
trigger	String	Exact match on the trigger value — the coupon code, email address, or SKU.
created_from	Int	Unix timestamp in seconds. Exclusive — matches rows created strictly after it.
created_to	Int	Unix timestamp in seconds. Inclusive — matches rows created at or before it.
updated_from	Int	Unix timestamp in seconds. Exclusive — matches rows updated strictly after it.
updated_to	Int	Unix timestamp in seconds. Inclusive — matches rows updated at or before it.
sort	String	Field to sort by, descending. Each type accepts its own short list — see Sorting on the returned type's page. Anything else is ignored without an error.
limit	Int	Rows to return. Anything outside 1–200 is replaced by 200.
before	ID	Returns only rows with an id lower than this. Cursor-style paging.
after	ID	Returns only rows with an id higher than this. Cursor-style paging.
offset	Int	Rows to skip before returning results.
first	Int	Acts as limit, but also forces sorting by id ascending and overrides any sort you pass.
last	Int	Acts as limit, but also forces sorting by id descending and overrides any sort you pass.

creatives

A list of creatives

Returns [Creative].

Argument	Type	Notes
id	ID	Returns only the record with this id.
status	ID	Exact match. The returned type lists the values that can appear.
type	ID	Exact match. The returned type lists the values that can appear.
created_from	Int	Unix timestamp in seconds. Exclusive — matches rows created strictly after it.
created_to	Int	Unix timestamp in seconds. Inclusive — matches rows created at or before it.
updated_from	Int	Unix timestamp in seconds. Exclusive — matches rows updated strictly after it.
updated_to	Int	Unix timestamp in seconds. Inclusive — matches rows updated at or before it.
sort	String	Field to sort by, descending. Each type accepts its own short list — see Sorting on the returned type's page. Anything else is ignored without an error.
limit	Int	Rows to return. Anything outside 1–200 is replaced by 200.
before	ID	Returns only rows with an id lower than this. Cursor-style paging.
after	ID	Returns only rows with an id higher than this. Cursor-style paging.
offset	Int	Rows to skip before returning results.
first	Int	Acts as limit, but also forces sorting by id ascending and overrides any sort you pass.
last	Int	Acts as limit, but also forces sorting by id descending and overrides any sort you pass.

offers

A list of offers

Returns [Offer].

Argument	Type	Notes
id	ID	Returns only the record with this id.
created_from	Int	Unix timestamp in seconds. Exclusive — matches rows created strictly after it.
created_to	Int	Unix timestamp in seconds. Inclusive — matches rows created at or before it.
updated_from	Int	Unix timestamp in seconds. Exclusive — matches rows updated strictly after it.
updated_to	Int	Unix timestamp in seconds. Inclusive — matches rows updated at or before it.
status	String	Exact match. The returned type lists the values that can appear.
type	String	Exact match. The returned type lists the values that can appear.
sort	String	Field to sort by, descending. Each type accepts its own short list — see Sorting on the returned type's page. Anything else is ignored without an error.
limit	Int	Rows to return. Anything outside 1–200 is replaced by 200.
before	ID	Returns only rows with an id lower than this. Cursor-style paging.
after	ID	Returns only rows with an id higher than this. Cursor-style paging.
offset	Int	Rows to skip before returning results.
first	Int	Acts as limit, but also forces sorting by id ascending and overrides any sort you pass.
last	Int	Acts as limit, but also forces sorting by id descending and overrides any sort you pass.

payments

A list of payments

Returns [Payment].

Argument	Type	Notes
id	ID	Returns only the record with this id.
created_from	Int	Unix timestamp in seconds. Exclusive — matches rows created strictly after it.
created_to	Int	Unix timestamp in seconds. Inclusive — matches rows created at or before it.
commission_total	String	Exact match on the stored value. This is not a range filter.
total	String	Exact match on the stored value. This is not a range filter.
sort	String	Field to sort by, descending. Each type accepts its own short list — see Sorting on the returned type's page. Anything else is ignored without an error.
limit	Int	Rows to return. Anything outside 1–200 is replaced by 200.
before	ID	Returns only rows with an id lower than this. Cursor-style paging.
after	ID	Returns only rows with an id higher than this. Cursor-style paging.
offset	Int	Rows to skip before returning results.
first	Int	Acts as limit, but also forces sorting by id ascending and overrides any sort you pass.
last	Int	Acts as limit, but also forces sorting by id descending and overrides any sort you pass.

product_feed

A list of products

Returns [ProductFeed].

Argument	Type	Notes
id	ID	Returns only the record with this id.
merchant_id	Int	Returns only records where this field equals the value you pass.
external_id	String	Returns only records where this field equals the value you pass.
name	String	Returns only records where this field equals the value you pass.
description	String	Returns only records where this field equals the value you pass.
tags	String	Returns only records where this field equals the value you pass.
price	Float	Returns only records where this field equals the value you pass.
currency	String	Returns only records where this field equals the value you pass.
product_url	String	Returns only records where this field equals the value you pass.
rfsn_parameter	String	Returns only records where this field equals the value you pass.
platform_id	Int	Returns only records where this field equals the value you pass.
sort	String	Field to sort by, descending. Each type accepts its own short list — see Sorting on the returned type's page. Anything else is ignored without an error.
limit	Int	Rows to return. Anything outside 1–200 is replaced by 200.
before	ID	Returns only rows with an id lower than this. Cursor-style paging.
after	ID	Returns only rows with an id higher than this. Cursor-style paging.
offset	Int	Rows to skip before returning results.
first	Int	Acts as limit, but also forces sorting by id ascending and overrides any sort you pass.
last	Int	Acts as limit, but also forces sorting by id descending and overrides any sort you pass.

merchants

Product feed merchants

Returns [Merchant].

Does not work

This root query returns Internal server error on every request, as does pageInfo { total_results { merchants } }. Read the store through product_feed { merchant { … } } instead.

Argument	Type	Notes
id	ID	Returns only the record with this id.
shop_name	String	Returns only records where this field equals the value you pass.
shop_identifier	String	Returns only records where this field equals the value you pass.
shop_url	String	Returns only records where this field equals the value you pass.
sort	String	Field to sort by, descending. Each type accepts its own short list — see Sorting on the returned type's page. Anything else is ignored without an error.
limit	Int	Rows to return. Anything outside 1–200 is replaced by 200.
before	ID	Returns only rows with an id lower than this. Cursor-style paging.
after	ID	Returns only rows with an id higher than this. Cursor-style paging.
offset	Int	Rows to skip before returning results.
first	Int	Acts as limit, but also forces sorting by id ascending and overrides any sort you pass.
last	Int	Acts as limit, but also forces sorting by id descending and overrides any sort you pass.

variants

Product feed variants

Returns [Variant].

Argument	Type	Notes
id	ID	Returns only the record with this id.
product_id	Int	Returns only records tied to this product.
external_id	String	Returns only records where this field equals the value you pass.
name	String	Returns only records where this field equals the value you pass.
price	String	Returns only records where this field equals the value you pass.
options	String	Returns only records where this field equals the value you pass.
sku	String	Returns only records where this field equals the value you pass.
sync_status	Boolean	Returns only records where this field equals the value you pass.
sort	String	Field to sort by, descending. Each type accepts its own short list — see Sorting on the returned type's page. Anything else is ignored without an error.
limit	Int	Rows to return. Anything outside 1–200 is replaced by 200.
before	ID	Returns only rows with an id lower than this. Cursor-style paging.
after	ID	Returns only rows with an id higher than this. Cursor-style paging.
offset	Int	Rows to skip before returning results.
first	Int	Acts as limit, but also forces sorting by id ascending and overrides any sort you pass.
last	Int	Acts as limit, but also forces sorting by id descending and overrides any sort you pass.

platforms

Product feed platforms

Returns [Platform].

Does not work

This root query returns Internal server error on every request. Read the platform through product_feed { vendor { … } } instead.

Argument	Type	Notes
id	ID	Returns only the record with this id.
name	String	Returns only records where this field equals the value you pass.
sort	String	Field to sort by, descending. Each type accepts its own short list — see Sorting on the returned type's page. Anything else is ignored without an error.
limit	Int	Rows to return. Anything outside 1–200 is replaced by 200.
before	ID	Returns only rows with an id lower than this. Cursor-style paging.
after	ID	Returns only rows with an id higher than this. Cursor-style paging.
offset	Int	Rows to skip before returning results.
first	Int	Acts as limit, but also forces sorting by id ascending and overrides any sort you pass.
last	Int	Acts as limit, but also forces sorting by id descending and overrides any sort you pass.

pageInfo

Deprecated

This will no longer return accurate results.

Will display pagination details

Returns PageInfo.

products

Collects information regarding products.

Returns [Product].

Does not work

This root query returns Internal server error on every request. Read line items through conversions { products { … } } instead.

Argument	Type	Notes
name	String	Returns only records where this field equals the value you pass.
SKU	String	Returns only records where this field equals the value you pass.
quantity	Int	Returns only records where this field equals the value you pass.
price	Float	Returns only records where this field equals the value you pass.
commission	Float	Returns only records where this field equals the value you pass.
commissionable_amount	Float	Returns only records where this field equals the value you pass.

shops

A list of clients associated with account.

Returns [Shop].

Marketplace tokens only.

Related

• Filtering and Sorting — argument semantics in full.
• Types — the shape of what these queries return.