{"variable":[{"id":"baseUrl","key":"baseUrl","type":"string","name":"string","value":"https:\/\/api.stage.clickgotrack.com"}],"info":{"name":"ClickGo API Documentation","_postman_id":"cc561026-bcc1-49cd-83b8-c955797b2132","description":"Public REST API for managing campaigns, creatives, advertisers and reporting data on the network. All endpoints are versioned under `\/api\/v1`.\n\n## Authentication\n\nAll requests must include an API key. Send it on every request using **either** of the following headers:\n\n```\nAuthorization: Bearer mk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n```\n\n```\nX-API-KEY: mk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n```\n\n## How to get an API key\n\n1. Open your ClickGo dashboard in a browser.\n2. Click **Settings** in the menu, then click **Network Settings**.\n3. Go to the **API Keys** tab.\n4. Click **Generate API Key** (or **Reveal API Key** if one already exists) and copy your Current Key.\n\n## Rate Limiting\n\nAll API requests are subject to per-second rate limits based on the role of the API key.\nOnce the limit is reached, the API returns **429 Too Many Requests** with the following body:\n\n```json\n{\n  \"code\": \"rate_limited\",\n  \"message\": \"Too many requests. Please slow down.\"\n}\n```\n\n### Request quotas\n\n| User | Limit |\n|-----------|----------------|\n| Network (Admin) | 60 requests\/second |\n| Publisher | 10 requests\/second |\n| Advertiser | 10 requests\/second |\n\n### Response headers\n\nEvery response includes headers indicating your current quota:\n\n| Header | Description |\n|--------|-------------|\n| `X-RateLimit-Limit` | Maximum requests allowed in the current window |\n| `X-RateLimit-Remaining` | Requests remaining in the current window |\n\nWhen rate-limited (429), two additional headers are included:\n\n| Header | Description |\n|--------|-------------|\n| `Retry-After` | Seconds to wait before retrying |\n| `X-RateLimit-Reset` | Unix timestamp (seconds) when the window resets |\n\n## Downloads\n\n- \ud83d\udce5 **Postman Collection** \u2014 [\/docs.postman](.\/docs.postman)\n- \ud83d\udcc4 **OpenAPI 3.0 Spec** \u2014 [\/docs.openapi](.\/docs.openapi)","schema":"https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json","version":"1.0.2"},"item":[{"name":"Account","description":"","item":[{"name":"Get account info","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/account\/info","query":[],"raw":"{{baseUrl}}\/api\/v1\/account\/info"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns details about the authenticated account: the user the API key\nbelongs to (name, email and role) and the network it operates on.\n\nUse this as the first call when integrating \u2014 a successful 200 confirms\nconnectivity, host resolution, API key validity and role assignment in a\nsingle round-trip."},"response":[{"header":[],"code":200,"body":"{\"data\":{\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane@acme.com\",\"role\":\"advertiser\",\"network\":{\"name\":\"Acme Network\",\"primary_domain\":\"acme.example.com\"}}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""}]}]},{"name":"Publishers","description":"","item":[{"name":"List Publishers","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/publishers","query":[{"key":"name","value":"jane","description":"Partial match on first or last name (case-insensitive).","disabled":false},{"key":"email","value":"@acme.com","description":"Partial match on email address (case-insensitive).","disabled":false},{"key":"status","value":"APPROVED,PENDING","description":"Comma-separated list of statuses. Allowed: `APPROVED`, `DENIED`, `TERMINATED`, `PENDING`.","disabled":false},{"key":"created_after","value":"2026-01-01","description":"Return only publishers created on or after this ISO date.","disabled":false},{"key":"created_before","value":"2026-12-31","description":"Return only publishers created on or before this ISO date.","disabled":false},{"key":"sort","value":"-created_at","description":"Sort by field. Prefix with `-` for descending. Allowed: `id`, `email`, `first_name`, `last_name`, `status`, `created_at`.","disabled":false},{"key":"per_page","value":"25","description":"Items per page. Defaults to 10. Max 100.","disabled":false},{"key":"page","value":"1","description":"Page number.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/admin\/publishers?name=jane&email=%40acme.com&status=APPROVED%2CPENDING&created_after=2026-01-01&created_before=2026-12-31&sort=-created_at&per_page=25&page=1"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"name\":\"b\",\"email\":\"zbailey@example.net\",\"status\":\"architecto\",\"created_after\":\"2026-07-02T22:57:28\",\"created_before\":\"2052-07-25\",\"sort\":\"-first_name\",\"per_page\":22}"},"description":"Returns a paginated list of publishers (affiliates) in your network.\nFilters are flat query parameters."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"id\":12,\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane@example.com\",\"status\":\"approved\",\"manager_id\":null,\"payment_schedule\":\"MONTHLY_NET30\",\"created_at\":\"2026-04-30T12:00:00Z\",\"updated_at\":\"2026-04-30T12:00:00Z\"}],\"links\":{\"first\":\"...\",\"last\":\"...\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"...\",\"per_page\":10,\"to\":1,\"total\":1}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]},{"name":"Create Publisher","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/publishers","query":[],"raw":"{{baseUrl}}\/api\/v1\/admin\/publishers"},"method":"POST","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane@example.com\",\"status\":\"APPROVED\",\"payment_schedule\":\"MONTHLY_NET30\"}"},"description":"Creates a new publisher (affiliate) in your network. The new publisher\nis assigned the default `publisher` role for your network. A random\npassword is generated; publishers cannot log in until you reset their\npassword from the dashboard."},"response":[{"header":[],"code":201,"body":"{\"data\":{\"id\":12,\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane@example.com\",\"status\":\"approved\",\"manager_id\":null,\"payment_schedule\":\"MONTHLY_NET30\",\"created_at\":\"2026-04-30T12:00:00Z\",\"updated_at\":\"2026-04-30T12:00:00Z\"}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":422,"body":"{\"code\":\"validation_failed\",\"message\":\"The given data was invalid.\",\"errors\":{\"email\":[\"A user with this email already exists.\"]}}","name":""}]},{"name":"Get Publisher","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/publishers\/:id","query":[],"raw":"{{baseUrl}}\/api\/v1\/admin\/publishers\/:id","variable":[{"id":"id","key":"id","value":12,"description":"The ID of the publisher."}]},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns a single publisher by its ID."},"response":[{"header":[],"code":200,"body":"{\"data\":{\"id\":12,\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane@example.com\",\"status\":\"approved\",\"manager_id\":null,\"payment_schedule\":\"MONTHLY_NET30\",\"created_at\":\"2026-04-30T12:00:00Z\",\"updated_at\":\"2026-04-30T12:00:00Z\"}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":404,"body":"{\"code\":\"not_found\",\"message\":\"The requested resource was not found.\"}","name":""}]},{"name":"Update Publisher","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/publishers\/:id","query":[],"raw":"{{baseUrl}}\/api\/v1\/admin\/publishers\/:id","variable":[{"id":"id","key":"id","value":12,"description":"The ID of the publisher."}]},"method":"PUT","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane@example.com\",\"status\":\"APPROVED\",\"payment_schedule\":\"MONTHLY_NET30\"}"},"description":"Partially updates a publisher by its ID. Only the\nfields you include in the body are updated. Manager assignment replaces\n(not appends to) any existing manager."},"response":[{"header":[],"code":200,"body":"{\"data\":{\"id\":12,\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane@example.com\",\"status\":\"approved\",\"manager_id\":null,\"payment_schedule\":\"WEEKLY_NET2\",\"created_at\":\"2026-04-30T12:00:00Z\",\"updated_at\":\"2026-04-30T13:00:00Z\"}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":404,"body":"{\"code\":\"not_found\",\"message\":\"The requested resource was not found.\"}","name":""},{"header":[],"code":422,"body":"{\"code\":\"validation_failed\",\"message\":\"The given data was invalid.\",\"errors\":{\"email\":[\"The email field must be a valid email address.\"]}}","name":""}]}]},{"name":"Campaigns","description":"","item":[{"name":"List Campaigns","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/campaigns","query":[{"key":"name","value":"spring","description":"Partial match on campaign name (case-insensitive).","disabled":false},{"key":"status","value":"ACTIVE","description":"Comma-separated list of statuses. Allowed: `ACTIVE`, `EXPIRING`, `EXPIRED`.","disabled":false},{"key":"offer_type","value":"public","description":"Comma-separated list of offer types. Allowed: `public`, `private`, `approval`.","disabled":false},{"key":"advertiser_id","value":"7","description":"Filter by parent advertiser ID.","disabled":false},{"key":"created_after","value":"2026-01-01","description":"Return only campaigns created on or after this ISO date.","disabled":false},{"key":"created_before","value":"2026-12-31","description":"Return only campaigns created on or before this ISO date.","disabled":false},{"key":"sort","value":"-created_at","description":"Sort by field. Prefix with `-` for descending. Allowed: `id`, `name`, `status`, `cpa`, `created_at`.","disabled":false},{"key":"per_page","value":"25","description":"Items per page. Defaults to 10. Max 100.","disabled":false},{"key":"page","value":"1","description":"Page number.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/admin\/campaigns?name=spring&status=ACTIVE&offer_type=public&advertiser_id=7&created_after=2026-01-01&created_before=2026-12-31&sort=-created_at&per_page=25&page=1"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"name\":\"b\",\"status\":\"n\",\"offer_type\":\"g\",\"advertiser_id\":16,\"created_after\":\"2026-07-02T22:57:28\",\"created_before\":\"2052-07-25\",\"sort\":\"name\",\"per_page\":22}"},"description":"Returns a paginated list of campaigns in your network. Filters are flat\nquery parameters; multiple values can be passed as a comma-separated list\n(e.g. `status=ACTIVE,EXPIRING`)."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"id\":101,\"name\":\"Spring Campaign\",\"advertiser_id\":7,\"offer_type\":\"public\",\"status\":\"ACTIVE\",\"payout\":18.00,\"created_at\":\"2026-04-20T12:00:00Z\"}],\"links\":{\"first\":\"...\",\"last\":\"...\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"...\",\"per_page\":10,\"to\":1,\"total\":1}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]},{"name":"Create Campaign","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/campaigns","query":[],"raw":"{{baseUrl}}\/api\/v1\/admin\/campaigns"},"method":"POST","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"name\":\"Spring Promo 2026\",\"advertiser_id\":7,\"offer_type\":\"public\",\"status\":\"ACTIVE\",\"category_id\":3,\"is_incentive\":false,\"url\":\"https:\\\/\\\/advertiser.example.com\\\/landing\",\"comment\":\"architecto\",\"converts_on\":\"Purchase\",\"converts_on_other\":\"architecto\",\"transaction_type\":\"cpc\",\"cpa\":12.5,\"is_rev_share\":false,\"is_cpc\":false,\"cpa_rs\":null,\"payout\":18,\"is_hard_cap_active\":false,\"hard_cap_date\":null,\"is_cap_active\":false,\"cap_limit\":null,\"cap_limit_frequency\":null,\"expiration_date\":\"2026-12-31\",\"device\":\"mobile\",\"os\":[\"linux\"],\"block_proxies\":false,\"proxy_tolerance\":\"standard\",\"enable_container\":false,\"countries\":[\"US\"]}"},"description":"Creates a new campaign in your network. All foreign-key fields\n(`advertiser_id`, `category_id`, redirect campaign \/ creative IDs) accept\ntenant-local IDs validated against your account.\n\n**Geo targeting** \u2014 pass `countries` as an array of ISO 3166-1 alpha-2\ncodes (e.g. `[\"US\",\"CA\"]`). Omit the field or pass `null` to target\n**all countries**. Use `GET \/admin\/countries` for the full supported list.\n\n**Device & OS targeting** \u2014 pass `device` (`\"mobile\"`, `\"desktop\"`, `\"all\"`)\nand\/or `os` (array of `\"ios\"`, `\"android\"`, `\"windows\"`, `\"mac\"`, `\"linux\"`).\nOmit or pass `null` on either field to allow all devices \/ OS."},"response":[{"header":[],"code":201,"body":"{\"data\":{\"id\":101,\"name\":\"Spring Promo 2026\",\"advertiser_id\":7,\"offer_type\":\"public\",\"status\":\"ACTIVE\",\"cpa\":12.50,\"payout\":18.00,\"is_rev_share\":false,\"is_incentive\":false,\"countries\":[\"US\",\"CA\"],\"geo_redirect_campaign_id\":null,\"geo_redirect_creative_id\":null,\"expired_redirect_campaign_id\":null,\"expired_redirect_creative_id\":null,\"campaign_cap_redirect_campaign_id\":null,\"campaign_cap_redirect_creative_id\":null,\"advertiser_cap_redirect_campaign_id\":null,\"advertiser_cap_redirect_creative_id\":null,\"device_redirect_campaign_id\":null,\"device_redirect_creative_id\":null,\"os_redirect_campaign_id\":null,\"os_redirect_creative_id\":null,\"created_at\":\"2026-04-30T12:00:00Z\"}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":422,"body":"{\"message\":\"The given data was invalid.\",\"errors\":{\"name\":[\"The name has already been taken.\"]}}","name":""}]},{"name":"Get Campaign","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/campaigns\/:id","query":[],"raw":"{{baseUrl}}\/api\/v1\/admin\/campaigns\/:id","variable":[{"id":"id","key":"id","value":42,"description":"The ID of the campaign."}]},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns the full detail of a single campaign by its ID."},"response":[{"header":[],"code":200,"body":"{\"data\":{\"id\":42,\"name\":\"Spring Promo 2026\",\"advertiser_id\":7,\"category_id\":3,\"offer_type\":\"public\",\"status\":\"ACTIVE\",\"description\":null,\"url\":\"https:\/\/...\",\"is_incentive\":false,\"is_rev_share\":false,\"cpa\":12.50,\"cpa_rs\":null,\"payout\":18.00,\"is_cap_active\":false,\"cap_limit\":null,\"cap_limit_frequency\":null,\"is_hard_cap_active\":false,\"hard_cap_date\":null,\"expiration_date\":null,\"device\":null,\"os\":null,\"block_proxies\":false,\"proxy_tolerance\":\"standard\",\"enable_container\":false,\"terms\":null,\"comment\":null,\"converts_on\":null,\"converts_on_other\":null,\"countries\":[\"US\",\"CA\"],\"geo_redirect_campaign_id\":null,\"geo_redirect_creative_id\":null,\"expired_redirect_campaign_id\":null,\"expired_redirect_creative_id\":null,\"campaign_cap_redirect_campaign_id\":null,\"campaign_cap_redirect_creative_id\":null,\"advertiser_cap_redirect_campaign_id\":null,\"advertiser_cap_redirect_creative_id\":null,\"device_redirect_campaign_id\":null,\"device_redirect_creative_id\":null,\"os_redirect_campaign_id\":null,\"os_redirect_creative_id\":null,\"created_at\":\"2026-04-20T12:00:00Z\",\"updated_at\":\"2026-04-20T12:00:00Z\"}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":404,"body":"{\"code\":\"not_found\",\"message\":\"Campaign not found.\"}","name":""}]},{"name":"Update Campaign","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/campaigns\/:id","query":[],"raw":"{{baseUrl}}\/api\/v1\/admin\/campaigns\/:id","variable":[{"id":"id","key":"id","value":42,"description":"The ID of the campaign."}]},"method":"PUT","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"name\":\"Spring Promo 2026 (updated)\",\"advertiser_id\":7,\"offer_type\":\"public\",\"category_id\":3,\"is_incentive\":false,\"url\":\"https:\\\/\\\/advertiser.example.com\\\/landing\",\"comment\":\"architecto\",\"terms\":\"architecto\",\"converts_on\":\"Purchase\",\"converts_on_other\":\"architecto\",\"transaction_type\":\"revshare\",\"cpa\":13,\"is_rev_share\":false,\"is_cpc\":true,\"payout\":18.5,\"is_hard_cap_active\":false,\"is_cap_active\":false,\"expiration_date\":\"2026-12-31\",\"status\":\"ACTIVE\",\"device\":\"mobile\",\"os\":[\"all\"],\"block_proxies\":false,\"proxy_tolerance\":\"standard\",\"enable_container\":false,\"countries\":[\"US\"]}"},"description":"Partially updates a campaign by its ID. Only the fields you include\nin the body are updated (PATCH semantics).\\n     *\\n     * **Geo targeting** \u2014 pass `countries` as an array of ISO 3166-1 alpha-2\\n     * codes. Omit the field to leave geo targeting unchanged; pass `null` to\\n     * clear it and target **all countries**.\\n     *\\n     * **Device & OS targeting** \u2014 pass `device` (`\\\"mobile\\\"`, `\\\"desktop\\\"`,\\n     * `\\\"all\\\"`) and\/or `os` (array of `\\\"ios\\\"`, `\\\"android\\\"`, `\\\"windows\\\"`,\\n     * `\\\"mac\\\"`, `\\\"linux\\\"`). Pass `null` to clear the restriction."},"response":[{"header":[],"code":200,"body":"{\"data\":{\"id\":42,\"name\":\"Spring Promo 2026 (updated)\",\"advertiser_id\":7,\"offer_type\":\"public\",\"status\":\"ACTIVE\",\"cpa\":13.00,\"payout\":18.50,\"countries\":[\"US\",\"CA\"],\"geo_redirect_campaign_id\":null,\"geo_redirect_creative_id\":null,\"expired_redirect_campaign_id\":null,\"expired_redirect_creative_id\":null}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":404,"body":"{\"code\":\"not_found\",\"message\":\"Campaign not found.\"}","name":""},{"header":[],"code":422,"body":"{\"message\":\"The given data was invalid.\",\"errors\":{\"cpa\":[\"The cpa must be at least 0.\"]}}","name":""}]}]},{"name":"Advertisers","description":"","item":[{"name":"List Advertisers","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/advertisers","query":[{"key":"name","value":"jane","description":"Partial match on first or last name (case-insensitive).","disabled":false},{"key":"email","value":"@acme.com","description":"Partial match on email address (case-insensitive).","disabled":false},{"key":"status","value":"APPROVED,PENDING","description":"Comma-separated list of statuses. Allowed: `APPROVED`, `DENIED`, `TERMINATED`, `PENDING`.","disabled":false},{"key":"created_after","value":"2026-01-01","description":"Return only advertisers created on or after this ISO date.","disabled":false},{"key":"created_before","value":"2026-12-31","description":"Return only advertisers created on or before this ISO date.","disabled":false},{"key":"sort","value":"-created_at","description":"Sort by field. Prefix with `-` for descending. Allowed: `id`, `email`, `first_name`, `last_name`, `created_at`.","disabled":false},{"key":"per_page","value":"25","description":"Items per page. Defaults to 10. Max 100.","disabled":false},{"key":"page","value":"1","description":"Page number.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/admin\/advertisers?name=jane&email=%40acme.com&status=APPROVED%2CPENDING&created_after=2026-01-01&created_before=2026-12-31&sort=-created_at&per_page=25&page=1"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"name\":\"b\",\"email\":\"zbailey@example.net\",\"status\":\"i\",\"created_after\":\"2026-07-02T22:57:28\",\"created_before\":\"2052-07-25\",\"sort\":\"id\",\"per_page\":22}"},"description":"Returns a paginated list of advertisers in your network. Filters are flat\nquery parameters."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"id\":7,\"company_name\":\"Acme Demand Co.\",\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane@acme.example.com\",\"status\":\"APPROVED\",\"manager_id\":null,\"payment_frequency\":null,\"created_at\":\"2026-04-30T12:00:00Z\",\"updated_at\":\"2026-04-30T12:00:00Z\"}],\"links\":{\"first\":\"...\",\"last\":\"...\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"...\",\"per_page\":10,\"to\":1,\"total\":1}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]},{"name":"Create Advertiser","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/advertisers","query":[],"raw":"{{baseUrl}}\/api\/v1\/admin\/advertisers"},"method":"POST","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"company_name\":\"Acme Demand Co.\",\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane@acme.example.com\"}"},"description":"Creates a new advertiser in your network. The new advertiser is assigned\nthe default `advertiser` role for your tenant. A random password is\ngenerated; advertisers cannot log into the dashboard until you reset\ntheir password from the UI."},"response":[{"header":[],"code":201,"body":"{\"data\":{\"id\":7,\"company_name\":\"Acme Demand Co.\",\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane@acme.example.com\",\"status\":\"approved\",\"manager_id\":null,\"payment_frequency\":null,\"created_at\":\"2026-04-30T12:00:00Z\",\"updated_at\":\"2026-04-30T12:00:00Z\"}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":422,"body":"{\"message\":\"The given data was invalid.\",\"errors\":{\"company_name\":[\"The company name has already been taken.\"]}}","name":""}]},{"name":"Get Advertiser","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/advertisers\/:id","query":[],"raw":"{{baseUrl}}\/api\/v1\/admin\/advertisers\/:id","variable":[{"id":"id","key":"id","value":7,"description":"The ID of the advertiser."}]},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns a single advertiser by its ID."},"response":[{"header":[],"code":200,"body":"{\"data\":{\"id\":7,\"company_name\":\"Acme Demand Co.\",\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane@acme.example.com\",\"status\":\"APPROVED\",\"manager_id\":null,\"payment_frequency\":null,\"created_at\":\"2026-04-30T12:00:00Z\",\"updated_at\":\"2026-04-30T12:00:00Z\"}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":404,"body":"{\"code\":\"not_found\",\"message\":\"Advertiser not found.\"}","name":""}]},{"name":"Update Advertiser","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/advertisers\/:id","query":[],"raw":"{{baseUrl}}\/api\/v1\/admin\/advertisers\/:id","variable":[{"id":"id","key":"id","value":7,"description":"The ID of the advertiser."}]},"method":"PUT","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"company_name\":\"Acme Demand Co. (Renamed)\",\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane@acme.example.com\",\"status\":\"APPROVED\",\"payment_frequency\":2}"},"description":"Partially updates an advertiser by its ID. Only\nthe fields you include in the body are updated. Manager assignment\nreplaces (not appends to) any existing manager."},"response":[{"header":[],"code":200,"body":"{\"data\":{\"id\":7,\"company_name\":\"Acme Demand Co. (Renamed)\",\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane@acme.example.com\",\"status\":\"APPROVED\",\"manager_id\":null,\"payment_frequency\":2,\"created_at\":\"2026-04-30T12:00:00Z\",\"updated_at\":\"2026-04-30T13:00:00Z\"}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":404,"body":"{\"code\":\"not_found\",\"message\":\"Advertiser not found.\"}","name":""},{"header":[],"code":422,"body":"{\"message\":\"The given data was invalid.\",\"errors\":{\"email\":[\"The email must be a valid email address.\"]}}","name":""}]}]},{"name":"Creatives","description":"","item":[{"name":"List Creatives","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/creatives","query":[{"key":"name","value":"banner","description":"Partial match on creative name (case-insensitive).","disabled":false},{"key":"campaign_id","value":"12","description":"Filter by parent campaign ID.","disabled":false},{"key":"type","value":"TEXT","description":"Filter by creative type. Allowed: `TEXT`, `DPLY`, `EMAIL`.","disabled":false},{"key":"is_active","value":"1","description":"Filter by activation flag.","disabled":false},{"key":"created_after","value":"2026-01-01","description":"Return only creatives created on or after this ISO date.","disabled":false},{"key":"created_before","value":"2026-12-31","description":"Return only creatives created on or before this ISO date.","disabled":false},{"key":"sort","value":"-created_at","description":"Sort by field. Prefix with `-` for descending. Allowed: `id`, `name`, `type`, `created_at`.","disabled":false},{"key":"per_page","value":"25","description":"Items per page. Defaults to 10. Max 100.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/admin\/creatives?name=banner&campaign_id=12&type=TEXT&is_active=1&created_after=2026-01-01&created_before=2026-12-31&sort=-created_at&per_page=25"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"name\":\"b\",\"campaign_id\":16,\"type\":\"DPLY\",\"is_active\":false,\"created_after\":\"2026-07-02T22:57:28\",\"created_before\":\"2052-07-25\",\"sort\":\"id\",\"per_page\":22}"},"description":"Returns a paginated list of creatives in your network. Filters are flat\nquery parameters."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"id\":7,\"campaign_id\":12,\"name\":\"Spring Banner 728x90\",\"destination_url\":\"https:\/\/...\",\"type\":\"TEXT\",\"is_active\":true,\"creative_redirect_id\":null,\"created_at\":\"2026-04-30T12:00:00Z\",\"updated_at\":\"2026-04-30T12:00:00Z\"}],\"links\":{\"first\":\"...\",\"last\":\"...\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"...\",\"per_page\":10,\"to\":1,\"total\":1}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":422,"body":"{\"message\":\"The selected type is invalid.\",\"errors\":{\"type\":[\"The selected type is invalid.\"]}}","name":""}]},{"name":"Create Creative","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/creatives","query":[],"raw":"{{baseUrl}}\/api\/v1\/admin\/creatives"},"method":"POST","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"campaign_id\":12,\"name\":\"Spring Banner 728x90\",\"destination_url\":\"https:\\\/\\\/advertiser.example.com\\\/landing\",\"type\":\"text\",\"is_active\":true}"},"description":"Creates a new text creative attached to a campaign. The `campaign_id`\nfield accepts a campaign ID. Display and email creatives\n(which require image\/file uploads) must be created via the dashboard."},"response":[{"header":[],"code":201,"body":"{\"data\":{\"id\":7,\"campaign_id\":12,\"name\":\"Spring Banner 728x90\",\"destination_url\":\"https:\/\/...\",\"type\":\"text\",\"is_active\":true,\"creative_redirect_id\":null,\"created_at\":\"2026-04-30T12:00:00Z\",\"updated_at\":\"2026-04-30T12:00:00Z\"}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":422,"body":"{\"message\":\"The given data was invalid.\",\"errors\":{\"campaign_id\":[\"The selected campaign id is invalid.\"]}}","name":""}]},{"name":"Get Creative","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/creatives\/:id","query":[],"raw":"{{baseUrl}}\/api\/v1\/admin\/creatives\/:id","variable":[{"id":"id","key":"id","value":7,"description":"The ID of the creative."}]},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns a single creative by its ID."},"response":[{"header":[],"code":200,"body":"{\"data\":{\"id\":7,\"campaign_id\":12,\"name\":\"Spring Banner 728x90\",\"destination_url\":\"https:\/\/...\",\"type\":\"text\",\"is_active\":true,\"creative_redirect_id\":null,\"created_at\":\"2026-04-30T12:00:00Z\",\"updated_at\":\"2026-04-30T12:00:00Z\"}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":404,"body":"{\"code\":\"not_found\",\"message\":\"Creative not found.\"}","name":""}]},{"name":"Update Creative","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/creatives\/:id","query":[],"raw":"{{baseUrl}}\/api\/v1\/admin\/creatives\/:id","variable":[{"id":"id","key":"id","value":7,"description":"The ID of the creative."}]},"method":"PUT","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"name\":\"Spring Banner v2\",\"destination_url\":\"https:\\\/\\\/advertiser.example.com\\\/spring-v2\",\"is_active\":true}"},"description":"Partially updates a creative by its ID. The\nparent `campaign_id` cannot be changed via this endpoint."},"response":[{"header":[],"code":200,"body":"{\"data\":{\"id\":7,\"campaign_id\":12,\"name\":\"Spring Banner v2\",\"destination_url\":\"https:\/\/...\",\"type\":\"text\",\"is_active\":true,\"creative_redirect_id\":null,\"created_at\":\"2026-04-30T12:00:00Z\",\"updated_at\":\"2026-04-30T13:00:00Z\"}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":404,"body":"{\"code\":\"not_found\",\"message\":\"Creative not found.\"}","name":""},{"header":[],"code":422,"body":"{\"message\":\"The given data was invalid.\",\"errors\":{\"destination_url\":[\"The destination url must be a valid URL.\"]}}","name":""}]}]},{"name":"Managers","description":"","item":[{"name":"List Managers","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/managers","query":[{"key":"type","value":"publisher","description":"Filter by manager type. Allowed: `publisher`, `advertiser`, `both`.","disabled":false},{"key":"sort","value":"first_name","description":"Sort by field. Prefix with `-` for descending. Allowed: `id`, `first_name`, `last_name`, `email`, `created_at`.","disabled":false},{"key":"per_page","value":"100","description":"Items per page. Defaults to 100. Max 100.","disabled":false},{"key":"page","value":"1","description":"Page number.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/admin\/managers?type=publisher&sort=first_name&per_page=100&page=1"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"type\":\"publisher\",\"sort\":\"-id\",\"per_page\":1}"},"description":"Returns a list of users who can be assigned as managers to publishers\nand\/or advertisers. Use the returned `id` when setting `manager_id` on\na publisher or advertiser."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"id\":3,\"first_name\":\"Alice\",\"last_name\":\"Smith\",\"email\":\"alice@example.com\",\"type\":\"publisher\"},{\"id\":4,\"first_name\":\"Bob\",\"last_name\":\"Jones\",\"email\":\"bob@example.com\",\"type\":\"both\"}],\"links\":{\"first\":\"...\",\"last\":\"...\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"...\",\"per_page\":100,\"to\":2,\"total\":2}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]}]},{"name":"Tracking Links","description":"","item":[{"name":"List Tracking Links","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/tracking-links","query":[{"key":"publisher_id","value":"15","description":"ID of the publisher whose eligible creatives to list. Required.","disabled":false},{"key":"campaign_id","value":"42","description":"Restrict results to a single campaign ID.","disabled":false},{"key":"creative_id","value":"7","description":"Restrict results to a single creative ID.","disabled":false},{"key":"creative_name","value":"Banner 300x250","description":"Partial, case-insensitive match on the creative name. Must not be greater than 255 characters.","disabled":false},{"key":"category_id","value":"3","description":"Filter creatives whose campaign belongs to this category ID.","disabled":false},{"key":"country","value":"US,CA","description":"Comma-separated ISO 3166-1 alpha-2 country codes; matches creatives whose campaign targets at least one of the listed countries.","disabled":false},{"key":"tracking_domain_id","value":"2","description":"Override the default tracking domain in the generated `tracking_url`. Use the IDs returned by `GET \/admin\/tracking-domains`.","disabled":false},{"key":"link_type","value":"tracking","description":"Which URL fields to populate. `tracking` (default) returns `tracking_url`\/`click_url`; `preview` returns only `preview_url`; `all` returns both.","disabled":false},{"key":"type","value":"TEXT","description":"Filter by creative type. Allowed: `DPLY`, `EMAIL`, `TEXT`.","disabled":false},{"key":"per_page","value":"25","description":"Items per page (1\u2013100). Must be at least 1. Must not be greater than 100.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/admin\/tracking-links?publisher_id=15&campaign_id=42&creative_id=7&creative_name=Banner%20300x250&category_id=3&country=US%2CCA&tracking_domain_id=2&link_type=tracking&type=TEXT&per_page=25"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns tracking links for a publisher's eligible creatives. Each record\nincludes a ready-to-use `tracking_url` (alias `click_url`).\n\nUse `tracking_domain_id` (see `GET \/admin\/tracking-domains`) to override\nthe default tracking domain in the generated URL. Use `link_type` to\nchoose which URLs are emitted."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"id\":7,\"type\":\"TEXT\",\"creative_name\":\"Banner 300x250\",\"creative_category\":\"Finance\",\"creative_countries\":[\"US\",\"CA\"],\"campaign_id\":42,\"publisher_id\":15,\"tracking_url\":\"https:\/\/track.example.com\/c\/abc123\",\"click_url\":\"https:\/\/track.example.com\/c\/abc123\",\"preview_url\":null}],\"links\":{\"first\":\"...\",\"last\":\"...\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"...\",\"per_page\":25,\"to\":1,\"total\":1}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":404,"body":"{\"code\":\"not_found\",\"message\":\"Publisher not found.\"}","name":""}]}]},{"name":"Tracking Domains","description":"","item":[{"name":"List Tracking Domains","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/tracking-domains","query":[],"raw":"{{baseUrl}}\/api\/v1\/admin\/tracking-domains"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns the tracking domains configured for your tenant. Use the\nreturned `id` value with the `tracking_domain_id` query parameter on\nthe tracking-links endpoint to override the default domain in the\ngenerated click URLs. The domain marked `is_default: true` is the one\nused when no override is provided."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"id\":1,\"hostname\":\"track.example.com\",\"is_default\":true},{\"id\":2,\"hostname\":\"go.example.com\",\"is_default\":false}]}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]}]},{"name":"Reference Data","description":"","item":[{"name":"List Countries","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/countries","query":[],"raw":"{{baseUrl}}\/api\/v1\/admin\/countries"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns the list of countries supported by the platform. Use the\nreturned ISO `code` values when assigning countries to a campaign."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"code\":\"US\",\"name\":\"United States\"},{\"code\":\"CA\",\"name\":\"Canada\"},{\"code\":\"BR\",\"name\":\"Brazil\"}]}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]}]},{"name":"Reporting","description":"","item":[{"name":"Entity Report","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/reporting\/entity","query":[{"key":"from","value":"2026-04-01","description":"Start of the reporting window in `YYYY-MM-DD` (interpreted in `timezone`). Defaults to today. Must be a valid date.","disabled":false},{"key":"to","value":"2026-04-30","description":"End of the reporting window in `YYYY-MM-DD` (interpreted in `timezone`). Defaults to today. Must be a valid date. Must be a date after or equal to from.","disabled":false},{"key":"timezone","value":"America\/New_York","description":"IANA timezone identifier. Defaults to your network timezone. Must be a valid time zone, such as Africa\/Accra.","disabled":false},{"key":"campaign_id","value":"42","description":"Restrict the report to a single campaign ID.","disabled":false},{"key":"publisher_id","value":"15","description":"Restrict the report to a single publisher ID.","disabled":false},{"key":"advertiser_id","value":"7","description":"Restrict the report to a single advertiser ID.","disabled":false},{"key":"per_page","value":"25","description":"Items per page. Defaults to 25. Max 100.","disabled":false},{"key":"group_by","value":"publisher","description":"Entity to aggregate by. One of: publisher, advertiser, campaign.","disabled":false},{"key":"page","value":"1","description":"Page number.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/admin\/reporting\/entity?from=2026-04-01&to=2026-04-30&timezone=America%2FNew_York&campaign_id=42&publisher_id=15&advertiser_id=7&per_page=25&group_by=publisher&page=1"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns aggregated performance metrics (clicks, conversions, revenue, CPA,\nprofit) grouped by `publisher`, `advertiser` or `campaign` for the given\ndate window. The response is paginated and ordered by total revenue\n(descending). All monetary values are in your network currency."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"id\":15,\"name\":\"Acme Publisher\",\"unique_clicks\":5230,\"converted_leads\":312,\"event_leads\":18,\"total_revenue_payout\":12480.50,\"total_cpa\":9123.00,\"total_profit\":3357.50,\"profit_margin\":0.2690,\"conversion_rate\":0.0596,\"earnings_per_click\":2.3863}],\"links\":{\"first\":\"https:\/\/example.test\/api\/v1\/admin\/reporting\/entity?page=1\",\"last\":\"https:\/\/example.test\/api\/v1\/admin\/reporting\/entity?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"https:\/\/example.test\/api\/v1\/admin\/reporting\/entity\",\"per_page\":25,\"to\":1,\"total\":1}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""},{"header":[],"code":422,"body":"{\"message\":\"The given data was invalid.\",\"errors\":{\"group_by\":[\"The selected group_by is invalid.\"]}}","name":""}]},{"name":"List Conversions","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/reporting\/conversions","query":[{"key":"from","value":"2026-04-01","description":"Start of the conversion window. Defaults to today. Must be a valid date.","disabled":false},{"key":"to","value":"2026-04-30","description":"End of the conversion window. Defaults to today. Must be a valid date. Must be a date after or equal to from.","disabled":false},{"key":"timezone","value":"America\/New_York","description":"IANA timezone identifier. Must be a valid time zone, such as Africa\/Accra.","disabled":false},{"key":"campaign_id","value":"42","description":"Public campaign ID to filter by.","disabled":false},{"key":"publisher_id","value":"15","description":"Public publisher ID to filter by.","disabled":false},{"key":"advertiser_id","value":"7","description":"Public advertiser ID to filter by.","disabled":false},{"key":"per_page","value":"25","description":"Items per page. Defaults to 25. Max 100.","disabled":false},{"key":"status","value":"PAYABLE","description":"Filter by derived status. One of: PAYABLE, PAID, PENDING, REVOKED, NOT_PAYABLE, BLOCKED.","disabled":false},{"key":"event_only","value":"","description":"When true, only event conversions are returned. When false, only non-event conversions.","disabled":true},{"key":"page","value":"1","description":"Page number.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/admin\/reporting\/conversions?from=2026-04-01&to=2026-04-30&timezone=America%2FNew_York&campaign_id=42&publisher_id=15&advertiser_id=7&per_page=25&status=PAYABLE&event_only=&page=1"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns a paginated list of credited conversions (leads with a\n`date_credited` value) inside the given window. By default returns both\nevent and non-event conversions; use `event_only` to scope. Use `status`\nto filter by derived status (PAYABLE, PAID, PENDING, REVOKED, NOT_PAYABLE,\nBLOCKED)."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"id\":\"01HV8XKP...\",\"campaign_id\":42,\"publisher_id\":15,\"creative_id\":7,\"event_id\":null,\"is_event\":false,\"status\":\"PAYABLE\",\"payout\":12.50,\"cpa\":9.00,\"subid_1\":\"src-fb\",\"subid_2\":null,\"subid_3\":null,\"subid_4\":null,\"subid_5\":null,\"subid_6\":null,\"subid_7\":null,\"ip_country_code\":\"US\",\"ip_region_name\":\"California\",\"created_at\":\"2026-04-20T10:15:00Z\",\"date_credited\":\"2026-04-20T10:18:00Z\"}],\"links\":{\"first\":\"...\",\"last\":\"...\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"...\",\"per_page\":25,\"to\":1,\"total\":1}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]},{"name":"List Clicks","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/reporting\/clicks","query":[{"key":"from","value":"2026-04-01","description":"Start of the click window. Defaults to today. Must be a valid date.","disabled":false},{"key":"to","value":"2026-04-30","description":"End of the click window. Defaults to today. Must be a valid date. Must be a date after or equal to from.","disabled":false},{"key":"timezone","value":"America\/New_York","description":"IANA timezone identifier. Must be a valid time zone, such as Africa\/Accra.","disabled":false},{"key":"campaign_id","value":"42","description":"Public campaign ID to filter by.","disabled":false},{"key":"publisher_id","value":"15","description":"Public publisher ID to filter by.","disabled":false},{"key":"advertiser_id","value":"7","description":"Public advertiser ID to filter by.","disabled":false},{"key":"per_page","value":"25","description":"Items per page. Defaults to 25. Max 100.","disabled":false},{"key":"page","value":"1","description":"Page number.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/admin\/reporting\/clicks?from=2026-04-01&to=2026-04-30&timezone=America%2FNew_York&campaign_id=42&publisher_id=15&advertiser_id=7&per_page=25&page=1"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns a paginated list of click rows (non-event leads) created inside\nthe given window. Use this endpoint for traffic-quality analysis,\ngeo\/device breakdowns or fraud review. Blocked clicks are\nincluded so you can audit them."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"id\":\"01HV8XKP...\",\"campaign_id\":42,\"publisher_id\":15,\"creative_id\":7,\"subid_1\":\"src-fb\",\"subid_2\":null,\"subid_3\":null,\"subid_4\":null,\"subid_5\":null,\"subid_6\":null,\"subid_7\":null,\"ip_country_code\":\"US\",\"ip_region_name\":\"California\",\"device\":\"desktop\",\"os\":\"mac\",\"is_blocked\":false,\"is_thr\":false,\"created_at\":\"2026-04-20T10:15:00Z\"}],\"links\":{\"first\":\"...\",\"last\":\"...\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"...\",\"per_page\":25,\"to\":1,\"total\":1}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]},{"name":"Daily Time Series","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/reporting\/daily","query":[{"key":"from","value":"2026-04-01","description":"Start of the reporting window. Defaults to today. Must be a valid date.","disabled":false},{"key":"to","value":"2026-04-30","description":"End of the reporting window. Defaults to today. Must be a valid date. Must be a date after or equal to from.","disabled":false},{"key":"timezone","value":"America\/New_York","description":"IANA timezone identifier. Must be a valid time zone, such as Africa\/Accra.","disabled":false},{"key":"campaign_id","value":"42","description":"Public campaign ID to filter by.","disabled":false},{"key":"publisher_id","value":"15","description":"Public publisher ID to filter by.","disabled":false},{"key":"advertiser_id","value":"7","description":"Public advertiser ID to filter by.","disabled":false},{"key":"per_page","value":"1","description":"Must be at least 1. Must not be greater than 100.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/admin\/reporting\/daily?from=2026-04-01&to=2026-04-30&timezone=America%2FNew_York&campaign_id=42&publisher_id=15&advertiser_id=7&per_page=1"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns one row per day for the given window with aggregated metrics\n(unique clicks, converted leads, event leads, revenue, CPA, profit).\nDays are emitted in the requested timezone and labelled `YYYY-MM-DD`."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"label\":\"2026-04-29\",\"unique_clicks\":1820,\"converted_leads\":94,\"event_leads\":6,\"total_revenue_payout\":3760.50,\"total_cpa\":2740.00,\"total_profit\":1020.50},{\"label\":\"2026-04-30\",\"unique_clicks\":2103,\"converted_leads\":118,\"event_leads\":9,\"total_revenue_payout\":4724.00,\"total_cpa\":3415.00,\"total_profit\":1309.00}]}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]},{"name":"Hourly Time Series","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/reporting\/hourly","query":[{"key":"from","value":"2026-04-01","description":"Start of the reporting window. Defaults to today. Must be a valid date.","disabled":false},{"key":"to","value":"2026-04-30","description":"End of the reporting window. Defaults to today. Must be a valid date. Must be a date after or equal to from.","disabled":false},{"key":"timezone","value":"America\/New_York","description":"IANA timezone identifier. Must be a valid time zone, such as Africa\/Accra.","disabled":false},{"key":"campaign_id","value":"42","description":"Public campaign ID to filter by.","disabled":false},{"key":"publisher_id","value":"15","description":"Public publisher ID to filter by.","disabled":false},{"key":"advertiser_id","value":"7","description":"Public advertiser ID to filter by.","disabled":false},{"key":"per_page","value":"1","description":"Must be at least 1. Must not be greater than 100.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/admin\/reporting\/hourly?from=2026-04-01&to=2026-04-30&timezone=America%2FNew_York&campaign_id=42&publisher_id=15&advertiser_id=7&per_page=1"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns one row per hour for the given window with aggregated metrics\n(unique clicks, converted leads, event leads, revenue, CPA, profit).\nHours are emitted in the requested timezone and labelled\n`YYYY-MM-DDTHH:00:00\u00b1HH:MM`. Defaults to today (00:00 \u2192 23:00) so a\ncall without parameters returns 24 buckets."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"label\":\"2026-04-30T00:00:00-04:00\",\"unique_clicks\":42,\"converted_leads\":3,\"event_leads\":0,\"total_revenue_payout\":120.00,\"total_cpa\":87.00,\"total_profit\":33.00}]}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]},{"name":"List Lead Snapshots","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/admin\/reporting\/leads","query":[{"key":"from","value":"2026-04-01","description":"date Start of the click window. Defaults to today.","disabled":false},{"key":"to","value":"2026-04-30","description":"date End of the click window. Defaults to today.","disabled":false},{"key":"timezone","value":"America\/New_York","description":"IANA timezone identifier.","disabled":false},{"key":"campaign_id","value":"42","description":"Public campaign ID.","disabled":false},{"key":"publisher_id","value":"15","description":"Public publisher ID.","disabled":false},{"key":"advertiser_id","value":"7","description":"Public advertiser ID.","disabled":false},{"key":"per_page","value":"25","description":"Rows per page (1\u2013100). Defaults to 25.","disabled":false},{"key":"status","value":"PAYABLE","description":"Filter by derived status. One of: PAYABLE, PAID, PENDING, REVOKED, NOT_PAYABLE, BLOCKED.","disabled":false},{"key":"event_only","value":"","description":"When true, only event leads.","disabled":true},{"key":"page","value":"1","description":"Page number.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/admin\/reporting\/leads?from=2026-04-01&to=2026-04-30&timezone=America%2FNew_York&campaign_id=42&publisher_id=15&advertiser_id=7&per_page=25&status=PAYABLE&event_only=&page=1"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns a paginated list of full lead snapshots inside the given click\nwindow. Each item contains three nested blocks: `lead` (core attributes,\nIDs, financials, URLs), `user_details` (device, browser, language) and\n`ip_intelligence` (residential\/proxy\/VPN signals, ISP, geo). Financial\nfields (`cpa`, `revenue`, `profit`) are zeroed for non-payable statuses.\n\n**Lead Status Guide**\n\n- `PAYABLE` \u2014 lead is approved and pending payment.\n- `PAID` \u2014 lead has been paid out.\n- `PENDING` \u2014 lead is awaiting advertiser approval (window not yet expired).\n- `REVOKED` \u2014 advertiser revoked the lead after initial approval.\n- `NOT_PAYABLE` \u2014 lead was not approved.\n- `BLOCKED` \u2014 lead was blocked at click time (e.g. fraud or compliance)."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"lead\":{\"id\":\"01HV8XKP...\",\"campaign_id\":42,\"campaign_name\":\"Demo\",\"advertiser_id\":7,\"advertiser_name\":\"Acme\",\"publisher_id\":15,\"publisher_name\":\"Pub Co\",\"creative_id\":3,\"event_id\":null,\"event_name\":null,\"category_name\":\"Finance\",\"click_time\":\"2026-04-20T10:15:00Z\",\"date_credited\":\"2026-04-20T10:18:00Z\",\"ip_address\":\"203.0.113.4\",\"subid_1\":\"src-fb\",\"subid_2\":null,\"subid_3\":null,\"subid_4\":null,\"subid_5\":null,\"subid_6\":null,\"subid_7\":null,\"status\":\"PAYABLE\",\"trigger\":\"postback\",\"original_url\":\"https:\/\/...\",\"original_url_creative\":\"https:\/\/...\",\"final_url\":\"https:\/\/...\",\"final_url_creative\":\"https:\/\/...\",\"cpa\":9.0,\"revenue\":12.5,\"profit\":3.5},\"user_details\":{\"device\":\"Mobile\",\"brand\":\"Apple iPhone\",\"os\":\"iOS\",\"browser_name\":\"Safari\",\"browser_version\":\"17.4\",\"referrer\":\"https:\/\/...\",\"language\":\"English\",\"user_agent\":\"Mozilla\/5.0...\"},\"ip_intelligence\":{\"ip_status\":false,\"is_residential\":true,\"is_mobile\":true,\"is_corporate\":false,\"is_edu\":false,\"is_public\":false,\"is_vpn\":false,\"is_proxy\":false,\"is_hosting\":false,\"is_hosting_cloud\":false,\"is_hosting_cloud_security\":false,\"is_hosting_web_browser\":false,\"is_darknet\":false,\"is_consumer_privacy\":false,\"ip_owner\":\"Verizon\",\"conn_type\":\"Mobile\",\"conn_speed\":\"high\",\"city\":\"New York\",\"region_name\":\"New York\",\"country_name\":\"United States\",\"latitude\":40.7128,\"longitude\":-74.006,\"time_zone\":\"America\/New_York\",\"zip_code\":\"10001\"}}],\"links\":{\"first\":\"...\",\"last\":\"...\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"...\",\"per_page\":25,\"to\":1,\"total\":1}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]}]},{"name":"Publisher Campaigns","description":"","item":[{"name":"Publisher Campaigns","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/publisher\/campaigns","query":[{"key":"name","value":"spring","description":"Partial match on campaign name (case-insensitive).","disabled":false},{"key":"offer_type","value":"public","description":"Comma-separated list of offer types. Allowed: `public`, `private`, `approval`.","disabled":false},{"key":"created_after","value":"2026-01-01","description":"Return only campaigns created on or after this ISO date.","disabled":false},{"key":"created_before","value":"2026-12-31","description":"Return only campaigns created on or before this ISO date.","disabled":false},{"key":"sort","value":"-created_at","description":"Sort by field. Prefix with `-` for descending. Allowed: `id`, `name`, `created_at`.","disabled":false},{"key":"per_page","value":"25","description":"Items per page. Defaults to 10. Max 100.","disabled":false},{"key":"page","value":"1","description":"Page number.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/publisher\/campaigns?name=spring&offer_type=public&created_after=2026-01-01&created_before=2026-12-31&sort=-created_at&per_page=25&page=1"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"name\":\"b\",\"offer_type\":\"ngzmiyvdljnikhwa\",\"created_after\":\"2026-07-02T22:57:28\",\"created_before\":\"2052-07-25\",\"sort\":\"-name\",\"per_page\":22}"},"description":"Returns a paginated list of offers available to the authenticated publisher,\nhonouring publisher restrictions and private offer access. Filters are flat\nquery parameters."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"id\":44,\"name\":\"Publisher Accessible Campaign\",\"offer_type\":\"public\",\"status\":\"ACTIVE\",\"payout\":18.00,\"created_at\":\"2026-04-20T12:00:00Z\"}],\"links\":{\"first\":\"...\",\"last\":\"...\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"...\",\"per_page\":10,\"to\":1,\"total\":1}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]}]},{"name":"Publisher Tracking Links","description":"","item":[{"name":"List My Tracking Links","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/publisher\/tracking-links","query":[{"key":"campaign_id","value":"42","description":"Restrict results to a single campaign ID.","disabled":false},{"key":"creative_id","value":"7","description":"Restrict results to a single creative ID.","disabled":false},{"key":"creative_name","value":"Banner 300x250","description":"Partial, case-insensitive match on the creative name. Must not be greater than 255 characters.","disabled":false},{"key":"category_id","value":"3","description":"Filter creatives whose campaign belongs to this category ID.","disabled":false},{"key":"country","value":"US,CA","description":"Comma-separated ISO 3166-1 alpha-2 country codes; matches creatives whose campaign targets at least one of the listed countries.","disabled":false},{"key":"tracking_domain_id","value":"2","description":"Override the default tracking domain in the generated `tracking_url`. Use the IDs returned by `GET \/publisher\/tracking-domains`.","disabled":false},{"key":"link_type","value":"tracking","description":"Which URL fields to populate. `tracking` (default) returns `tracking_url`\/`click_url`; `preview` returns only `preview_url`; `all` returns both.","disabled":false},{"key":"type","value":"TEXT","description":"Filter by creative type. Allowed: `DPLY`, `EMAIL`, `TEXT`.","disabled":false},{"key":"per_page","value":"25","description":"Items per page (1\u2013100). Must be at least 1. Must not be greater than 100.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/publisher\/tracking-links?campaign_id=42&creative_id=7&creative_name=Banner%20300x250&category_id=3&country=US%2CCA&tracking_domain_id=2&link_type=tracking&type=TEXT&per_page=25"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns the tracking links available to the authenticated publisher.\nEach item includes the obfuscated `tracking_url` (alias `click_url`)\nready to be served. Honours restricted advertisers\/campaigns and\nprivate\/approval offer access.\n\nUse `tracking_domain_id` (see `GET \/publisher\/tracking-domains`) to\noverride the default tracking domain in the generated URL. Use\n`link_type` to choose which URLs are emitted."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"id\":7,\"type\":\"TEXT\",\"creative_name\":\"Banner 300x250\",\"creative_category\":\"Finance\",\"creative_countries\":[\"US\",\"CA\"],\"campaign_id\":42,\"publisher_id\":15,\"tracking_url\":\"https:\/\/track.example.com\/c\/abc123\",\"click_url\":\"https:\/\/track.example.com\/c\/abc123\",\"preview_url\":null}],\"links\":{\"first\":\"...\",\"last\":\"...\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"...\",\"per_page\":25,\"to\":1,\"total\":1}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]}]},{"name":"Publisher Tracking Domains","description":"","item":[{"name":"List Tracking Domains","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/publisher\/tracking-domains","query":[],"raw":"{{baseUrl}}\/api\/v1\/publisher\/tracking-domains"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns the tracking domains configured for your network. Use the\nreturned `id` value with the `tracking_domain_id` query parameter on\nthe tracking-links endpoint to override the default domain."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"id\":1,\"hostname\":\"track.example.com\",\"is_default\":true},{\"id\":2,\"hostname\":\"go.example.com\",\"is_default\":false}]}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]}]},{"name":"Publisher Reporting","description":"","item":[{"name":"List My Lead Snapshots","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/publisher\/leads","query":[{"key":"from","value":"2026-04-01","description":"Start of the click window (date the lead was created). Defaults to today. Must be a valid date.","disabled":false},{"key":"to","value":"2026-04-30","description":"End of the click window. Defaults to today. Must be a valid date. Must be a date after or equal to from.","disabled":false},{"key":"timezone","value":"America\/New_York","description":"IANA timezone identifier. Must be a valid time zone, such as Africa\/Accra.","disabled":false},{"key":"campaign_id","value":"42","description":"Public campaign ID to filter by.","disabled":false},{"key":"publisher_id","value":"16","description":"","disabled":false},{"key":"advertiser_id","value":"16","description":"","disabled":false},{"key":"per_page","value":"25","description":"Rows per page (1\u2013100). Defaults to 25. Must be at least 1. Must not be greater than 100.","disabled":false},{"key":"status","value":"PAYABLE","description":"Filter by derived status. One of: PAYABLE, PAID, PENDING, REVOKED, NOT_PAYABLE, BLOCKED.","disabled":false},{"key":"event_only","value":"","description":"When true, only event leads are returned. When false, only non-event leads.","disabled":true}],"raw":"{{baseUrl}}\/api\/v1\/publisher\/leads?from=2026-04-01&to=2026-04-30&timezone=America%2FNew_York&campaign_id=42&publisher_id=16&advertiser_id=16&per_page=25&status=PAYABLE&event_only="},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":null,"description":"Returns a paginated list of full lead snapshots for the authenticated\npublisher inside the given click window. Any `publisher_id` query\nparameter is ignored; results are always scoped to the authenticated\npublisher.\n\n**Lead Status Guide**\n\n- `PAYABLE` \u2014 lead is approved and pending payment.\n- `PAID` \u2014 lead has been paid out.\n- `PENDING` \u2014 lead is awaiting advertiser approval (window not yet expired).\n- `REVOKED` \u2014 advertiser revoked the lead after initial approval.\n- `NOT_PAYABLE` \u2014 lead was not approved.\n- `BLOCKED` \u2014 lead was blocked at click time (e.g. fraud or compliance)."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"lead\":{\"id\":\"01HV8XKP...\",\"campaign_id\":42,\"campaign_name\":\"Demo Campaign\",\"publisher_id\":15,\"publisher_name\":\"Pub Co\",\"creative_id\":3,\"event_id\":null,\"event_name\":null,\"category_name\":\"Finance\",\"cpa\":12.50,\"click_time\":\"2026-04-20T10:15:00Z\",\"date_credited\":\"2026-04-20T10:18:00Z\",\"ip_address\":\"203.0.113.4\",\"subid_1\":\"src-ig\",\"subid_2\":null,\"subid_3\":null,\"subid_4\":null,\"subid_5\":null,\"subid_6\":null,\"subid_7\":null,\"status\":\"PAYABLE\",\"trigger\":\"postback\",\"original_url\":\"https:\/\/...\",\"original_url_creative\":\"https:\/\/...\",\"final_url\":\"https:\/\/...\",\"final_url_creative\":\"https:\/\/...\"},\"user_details\":{\"device\":\"Mobile\",\"brand\":\"Apple iPhone\",\"os\":\"iOS\",\"browser_name\":\"Safari\",\"browser_version\":\"17.4\",\"referrer\":\"https:\/\/...\",\"language\":\"English\",\"user_agent\":\"Mozilla\/5.0...\"},\"ip_intelligence\":{\"ip_status\":false,\"is_residential\":true,\"is_mobile\":true,\"is_corporate\":false,\"is_edu\":false,\"is_public\":false,\"is_vpn\":false,\"is_proxy\":false,\"is_hosting\":false,\"is_hosting_cloud\":false,\"is_hosting_cloud_security\":false,\"is_hosting_web_browser\":false,\"is_darknet\":false,\"is_consumer_privacy\":false,\"ip_owner\":\"Verizon\",\"conn_type\":\"Mobile\",\"conn_speed\":\"high\",\"city\":\"New York\",\"region_name\":\"New York\",\"country_name\":\"United States\",\"latitude\":40.7128,\"longitude\":-74.006,\"time_zone\":\"America\/New_York\",\"zip_code\":\"10001\"}}],\"links\":{\"first\":\"...\",\"last\":\"...\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"...\",\"per_page\":25,\"to\":1,\"total\":1}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]}]},{"name":"Advertiser Campaigns","description":"","item":[{"name":"Advertiser Campaigns","request":{"url":{"host":"{{baseUrl}}","path":"api\/v1\/advertiser\/campaigns","query":[{"key":"name","value":"spring","description":"Partial match on campaign name (case-insensitive).","disabled":false},{"key":"status","value":"ACTIVE","description":"Comma-separated list of statuses. Allowed: `ACTIVE`, `EXPIRING`, `EXPIRED`.","disabled":false},{"key":"offer_type","value":"public","description":"Comma-separated list of offer types. Allowed: `public`, `private`, `approval`.","disabled":false},{"key":"created_after","value":"2026-01-01","description":"Return only campaigns created on or after this ISO date.","disabled":false},{"key":"created_before","value":"2026-12-31","description":"Return only campaigns created on or before this ISO date.","disabled":false},{"key":"sort","value":"-created_at","description":"Sort by field. Prefix with `-` for descending. Allowed: `id`, `name`, `status`, `cpa`, `created_at`.","disabled":false},{"key":"per_page","value":"25","description":"Items per page. Defaults to 10. Max 100.","disabled":false},{"key":"page","value":"1","description":"Page number.","disabled":false}],"raw":"{{baseUrl}}\/api\/v1\/advertiser\/campaigns?name=spring&status=ACTIVE&offer_type=public&created_after=2026-01-01&created_before=2026-12-31&sort=-created_at&per_page=25&page=1"},"method":"GET","header":[{"key":"Content-Type","value":"application\/json"},{"key":"Accept","value":"application\/json"}],"body":{"mode":"raw","raw":"{\"name\":\"b\",\"status\":\"n\",\"offer_type\":\"gzmiyvdljnikhway\",\"created_after\":\"2026-07-02T22:57:28\",\"created_before\":\"2052-07-25\",\"sort\":\"name\",\"per_page\":22}"},"description":"Returns a paginated list of campaigns owned by the authenticated advertiser.\nFilters are flat query parameters; multiple values can be passed as a\ncomma-separated list (e.g. `status=ACTIVE,EXPIRING`)."},"response":[{"header":[],"code":200,"body":"{\"data\":[{\"id\":12,\"name\":\"Advertiser Owned Campaign\",\"advertiser_id\":7,\"offer_type\":\"public\",\"status\":\"ACTIVE\",\"payout\":18.00,\"created_at\":\"2026-04-20T12:00:00Z\"}],\"links\":{\"first\":\"...\",\"last\":\"...\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"path\":\"...\",\"per_page\":10,\"to\":1,\"total\":1}}","name":""},{"header":[],"code":401,"body":"{\"code\":\"unauthenticated\",\"message\":\"Authentication is required to access this resource.\"}","name":""},{"header":[],"code":403,"body":"{\"code\":\"forbidden\",\"message\":\"You are not authorized to perform this action.\"}","name":""}]}]}],"auth":{"type":"bearer","bearer":[{"key":"Authorization","type":"string"}]}}