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 |
Use these three tools for entity types not covered by the dedicated tools above — advertisers, creatives, invoices, pixels, and more. Call get_entity_schema with no arguments first to see every supported type and its available filters.
get_entity_schema
Returns the available filters, include options, and field descriptions for any entity type.
Parameters:
| Parameter | Type | Required | Description |
|---|
type | string | No | Entity type. Leave empty to list all supported types. — max 64 chars |
offer, affiliate, affiliate_user, advertiser, advertiser_user, tracking_domain, click, conversion, creative, custom_creative, custom_payout_revenue, invoice, offer_group, campaign, pixel, coupon_code, application, click_error_code, conversion_error_code
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 |
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 (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 |
Passing an unrecognized type returns INVALID_ARGUMENT: Unknown entity type '…'. Call get_entity_schema with no arguments to see every supported type.
| 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 |
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 |
