get_account_info
Returns information about the current network account and the authenticated user. Call this first in any session to confirm the default currency and timezone before running reports.
Parameters: None.
Response fields:
| Field | Type | Description |
|---|
network.network_id | number | Numeric network ID |
network.name | string | Network name |
network.account_status | string | Account status |
network.currency | string | Default currency code |
network.support_email | string | Network support email |
network.time_created | datetime | Account creation date |
network.timezone | string | Default timezone (IANA) |
current_user.employee_id | number | Authenticated employee ID |
current_user.name | string | Full name |
current_user.title | string | Job title |
current_user.is_admin | boolean | Admin access |
current_user.is_affiliate_manager | boolean | Has affiliate management scope |
current_user.is_limited_affiliate_scope | boolean | Scoped to specific affiliates only |
current_user.is_advertiser_manager | boolean | Has advertiser management scope |
current_user.timezone | string | User’s timezone (IANA) |
current_user.currency | string | User’s default currency |
tracking.primary_domain | string | Primary tracking domain URL |
get_entity_schema
Returns the available filters, include options, and field descriptions for any entity type. Call it with no arguments to list every supported type — the full catalog is also documented in Supported entity types below.
Parameters:
| Parameter | Type | Required | Description |
|---|
type | string | No | Entity type. Leave empty to list all supported types. — max 64 chars |
get_entity
Retrieves a single entity by its primary ID.
Parameters:
| Parameter | Type | Required | Description |
|---|
type | string | Yes | Entity type (from get_entity_schema) — max 64 chars |
id | string | Yes | Primary ID of the entity — max 64 chars |
include | string | No | Comma-separated relationship names (from get_entity_schema) — max 1,024 chars |
parameters | string | No | JSON object of additional query parameters — max 4,096 chars |
click, conversion, and transaction response shapes are documented on Events & Attribution.
Passing an unrecognized type returns INVALID_ARGUMENT: Unknown entity type '…'. Call get_entity_schema with no arguments to see every supported type.
list_entities
Lists entities of a given type with filters and pagination.
Parameters:
| Parameter | Type | Required | Description |
|---|
type | string | Yes | Entity type (from get_entity_schema) — max 64 chars |
filters | string | No | JSON object of filter key-value pairs — e.g. {"affiliate_id": "142", "status": "active"} (use get_entity_schema to see available filters) — max 4,096 chars |
page_size | number | No | Rows per page (1–200, default 25) |
cursor | string | No | Pagination cursor from a prior response — max 1,024 chars |
The filters parameter here is a JSON object — this differs from run_performance_report, which uses comma-separated type:value strings.
| Field | Type | Description |
|---|
has_more | boolean | true if additional pages exist |
next_cursor | string | Pass as cursor to retrieve the next page |
rows_returned | number | Number of records in this page |
total_matching | number | Total records matching the query |
Supported entity types
The generic tools cover 32 entity types. Three have richer documentation elsewhere: offer and affiliate have dedicated tools with more parameters — prefer those — and the event types are detailed on Events & Attribution.
Core entities
| Type | Description | Filters | Notes |
|---|
offer | Campaign / promotion | — | Prefer get_offer / list_offers |
affiliate | Partner / publisher | — | Prefer get_affiliate / list_affiliates |
Events & attribution
| Type | Description | Filters | Notes |
|---|
click | Click event | from/to (required, 14-day max), transaction_id, offer_id, affiliate_id, advertiser_id, error_code, country, source_id, sub1–sub10 | id is the 32-char transaction ID — see Events & Attribution |
conversion | Conversion event | from/to (required), conversion_id, status, offer_id, affiliate_id, advertiser_id, country, source_id, sub1–sub10, adv1–adv10 | id is the conversion ID — see Events & Attribution |
transaction | Full attribution chain for a transaction | None — fetch by ID | id is the 32-char transaction ID — see Events & Attribution |
People & access
| Type | Description | Filters | Notes |
|---|
advertiser | Advertiser (brand / product owner) | search, status | |
advertiser_user | Contact on an advertiser account | advertiser_id | |
affiliate_user | Contact on an affiliate account | affiliate_id | |
employee | Internal team member (account manager, admin) | search, status, is_admin, is_affiliate_manager, is_advertiser_manager, role_id, business_unit_id | |
application | Partner request to join an offer | affiliate_id, offer_id, status, search | Status: pending, approved, rejected |
Offer structure
| Type | Description | Filters | Notes |
|---|
offer_group | Logical grouping of related offers | search, status | |
campaign | Smart Link | search, status | campaign is the API name for what the platform calls “Smart Link” |
offer_url | Tracking / destination URL on an offer | offer_id (required) | Always requires the parent offer |
creative | Ad creative (banner, text link, email) | offer_id, search, status | |
custom_creative | Custom creative variant | offer_id | |
custom_payout_revenue | Custom payout / revenue rule | offer_id | |
pixel | Conversion tracking pixel | offer_id | |
coupon_code | Coupon code assigned to an affiliate | At least one filter required (affiliate_id, offer_id) | |
advertiser_event | Conversion event / goal defined by an advertiser | advertiser_id (required) | Always requires the parent advertiser |
Classification & tagging
| Type | Description | Filters | Notes |
|---|
category | Offer classification tag | search, status | |
channel | Marketing channel (e.g. email, social, search) | search, status | |
label | Cross-resource tag | search | String-based — pass label text as id for get_entity |
affiliate_tier | Grouping tier for affiliates with payout margin | search, status | |
Infrastructure & reporting
| Type | Description | Filters | Notes |
|---|
tracking_domain | Custom tracking domain | search | |
invoice | Affiliate payment invoice | affiliate_id, status | |
click_error_code | Static lookup — click error code definitions | None | Use numeric error code as id |
conversion_error_code | Static lookup — conversion error code definitions | None | Use numeric error code as id |
| Type | Description | Filters | Notes |
|---|
country | Country reference data (global) | search | Resolve to country_id (scopes a region lookup) / ISO code for the report country filter |
region | Region / state reference data (global) | search, country_id | Resolve a name to region_id for the report region filter |
city | City reference data (global) | region_id (required), search | Resolve a name to city_id for the report city filter |
Two entity types have non-obvious identifiers: campaign is the API name for Smart Links (not campaigns in the general sense); and label uses the label’s text value as its id — not a numeric ID. For example: get_entity(type="label", id="top_affiliate").
search_documentation
Searches Everflow’s help center and API documentation. Use this to look up feature details, setup instructions, or API endpoint specifics.
Parameters:
| Parameter | Type | Required | Description |
|---|
query | string | Yes | Search query — max 512 chars |
source | string | No | all (default), help_center, or api_docs — max 64 chars |
source=help_center for operational how-to content and source=api_docs for endpoint and parameter references.