Tool reference

Every tool the Zeydoo MCP connector exposes, generated straight from the live registry.

Write operations would be labeled; today every tool is read-only.

• List my offers get_my_offers read-only

  Get the offers connected to your own Zeydoo account. Each offer has an id, title, status, targeting (include/exclude sets over os, browser, country, os_type, connection, mobile_isp, language, os_version, device_type), and rates — the payout amount per country group that applies to you. Use this rather than get_offers when the question is about what you can actually run and what it pays. Paginated by this server, ordered by id. The response carries meta { page, page_size, total_items, total_pages, has_more }; page_size defaults to 100 and is capped at 500. To fetch everything, keep page_size fixed and walk page from 1 to total_pages.

  Parameters

  • page number — Page number (default: 1)
  • page_size number — Offers per page (default: 100, maximum: 500). Larger values are clamped to the maximum.

• List all offers get_offers read-only

  Get the full Zeydoo offer catalogue. Each offer has an id, title, status, and targeting (include/exclude sets over os, browser, country, os_type, connection, mobile_isp, language, os_version, device_type). Payout rates are NOT included — use get_my_offers for the rates that apply to your account. Paginated by this server, ordered by id. The response carries meta { page, page_size, total_items, total_pages, has_more }; page_size defaults to 100 and is capped at 500. To fetch everything, keep page_size fixed and walk page from 1 to total_pages.

  Parameters

  • page number — Page number (default: 1)
  • page_size number — Offers per page (default: 100, maximum: 500). Larger values are clamped to the maximum.

• Get account balance get_balance read-only

  Get the current account balance: total_balance and the portion still in_hold.

  No parameters

• Get account access level get_me read-only

  Get the authenticated account's Zeydoo id and its API access_level. The level is 'base' for the standard endpoints, or 'extended', which additionally allows get_statistics to group by request_var and by more than one field at a time. Check it before offering either of those groupings, or to explain why get_statistics refused one.

  No parameters

• Get statistics get_statistics read-only

  Get Zeydoo traffic statistics with flexible grouping and filtering. Metrics returned per row: requests, impressions, conversions, money (earnings) — all delivered as strings (e.g. "2860.36"), parse them as numbers before summing or comparing. Grouping adds the corresponding key to each row (date_time, zone_id, geo, platform, request_var); geo is the two-letter ISO country code, the same value the countries filter takes. The response also carries a meta block with total_items, total_pages, page_size and page. Paginated upstream: page_size defaults to 100 and is capped at 200. To fetch everything, keep page_size fixed and walk page from 1 to meta.total_pages; prefer narrowing the date range or filters over walking many pages. Every parameter is optional; omitting date_from/date_to returns the API's own default range. Grouping by zone_id is markedly slower upstream than the other groupings (tens of seconds, whatever the date range) — ask for it only when zone-level numbers are needed. Examples: - Daily earnings: { date_from: "2024-01-01", date_to: "2024-01-07", group_by: ["date_time"] } - By country: { ..., group_by: ["geo"] } - Named zones: { ..., group_by: ["zone_id"], show_names: true }

  Parameters

  • group_by array — Fields to group by. Grouping by 'request_var', or by more than one field at a time, requires the 'extended' API access level — such a request checks the account's level first (the value get_me returns) and is refused before the query runs when the level is lower; your manager or Zeydoo support can raise it.
  • date_from string — Date FROM in YYYY-MM-DD format
  • date_to string — Date TO in YYYY-MM-DD format
  • zone_ids array — Filter by zone IDs
  • countries array — 2-letter ISO 3166 Alpha-2 country codes, e.g. ['us', 'it']
  • show_names boolean — Add human-readable zone_name / platform_name to rows grouped by zone_id or platform
  • tz string — UTC offset for bucketing, e.g. '+0300' or '-0500' (range -1200..+1400). Honoured only while date_from is within the last 7 days: for an older range the API answers 400 "Time zone is available only in the weekly period." — omit tz to query older data.
  • page number — Page number (default: 1)
  • page_size number — Rows per page (default: 100, maximum: 200). Larger values are clamped to the maximum.