Retrieve every Customer Value rule defined for the network, in any state. Not paginated and takes no filters.Pass relationship=event to resolve the display names of the scoped and tied payout/revenue events into the relationship object.
Include related data. Use event to resolve the display names of the scoped and tied payout/revenue events, or all for the same result. Repeat the parameter for multiple values.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Everflow API","colors":{"primary":"#4332a5","light":"#5a4bbf","dark":"#362888"},"logo":{"light":"https://mintcdn.com/everflowtechnologies/vVJLGBUt_z0g35hz/logo/everflow.png?fit=max\u0026auto=format\u0026n=vVJLGBUt_z0g35hz\u0026q=85\u0026s=437ab9116ac53bbfd222d2fd57a4af08","dark":"https://mintcdn.com/everflowtechnologies/vVJLGBUt_z0g35hz/logo/everflow.png?fit=max\u0026auto=format\u0026n=vVJLGBUt_z0g35hz\u0026q=85\u0026s=437ab9116ac53bbfd222d2fd57a4af08"},"favicon":"https://mintcdn.com/everflowtechnologies/degOs2kSev-1kJgB/favicon.png?fit=max\u0026auto=format\u0026n=degOs2kSev-1kJgB\u0026q=85\u0026s=b732acd7cf57fedc617c997d2978072d","appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"https://developers-legacy.everflow.io/","label":"Legacy Docs"},{"href":"/changelog","label":"Changelog"},{"href":"https://status.everflow.io","label":"Status"},{"href":"https://helpdesk.everflow.io/","label":"Support"}]},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"everflowtechnologies","hasAudioNarration":false,"actualSubdomain":"everflowtechnologies","customDomains":["developers.everflow.io"],"gitSource":{"type":"github","owner":"everflow-io","repo":"everflow-developers-hub","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad559ef230ac7daca57610b","collectionId":"f3fccaf5-3944-497d-b928-a6103cd14a48","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad559ef230ac7daca57610b"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae0f65b3801202aa4766117","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"Network API","count":432},{"language":"default","tag":"Affiliate API","count":76},{"language":"default","tag":"User Guide","count":56},{"language":"default","tag":"Reporting","count":38},{"language":"default","tag":"MCP Server","count":22},{"language":"default","tag":"Webhooks","count":19},{"language":"default","tag":"Marketplace API","count":18},{"language":"default","tag":"Offers","count":17},{"language":"default","tag":"Network MCP","count":14},{"language":"default","tag":"Advertiser API","count":14}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@everflow.io"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar-transition{background-color:rgb(249 250 251)!important;border-bottom:1px solid rgb(229 231 235)!important}.dark #navbar-transition{background-color:rgb(17 24 39)!important;border-bottom-color:rgb(55 65 81)!important}.tryit-button{background-color:#4332a5!important}#sidebar-group>li[data-title]>ul{margin-left:1rem;padding-left:.75rem;border-left:2px solid rgb(209 213 219)}.dark #sidebar-group>li[data-title]>ul{border-left-color:rgb(75 85 99)}"}],"page":{"pagePath":"api-reference/get-networkscustomervaluerules","slug":"/api-reference/get-networkscustomervaluerules","pageMetadata":{"title":"List Rules","openapi":"openapi/customer-value.yaml get /networks/customervalue/rules","description":"Retrieve every Customer Value rule defined for the network. This endpoint is not paginated and takes no filters.\n","href":"/api-reference/get-networkscustomervaluerules"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve every Customer Value rule defined for the network. This endpoint is not paginated and takes no filters.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Retrieve every Customer Value rule defined for the network, in any `,_jsx(_components.code,{children:`state`}),`. Not paginated and takes no filters.`]}),`\n`,_jsxs(_components.p,{children:[`Pass `,_jsx(_components.code,{children:`relationship=event`}),` to resolve the display names of the scoped and tied payout/revenue events into the `,_jsx(_components.code,{children:`relationship`}),` object.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List Rules","openapi":"openapi/customer-value.yaml get /networks/customervalue/rules","description":"Retrieve every Customer Value rule defined for the network. This endpoint is not paginated and takes no filters.\n","href":"/api-reference/get-networkscustomervaluerules"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/everflowtechnologies/94e4a563b6e403c8/sidebar-lines.js"],"openApiReferenceData":{"operation":{"summary":"List Rules","description":"Retrieve every Customer Value rule defined for the network. This endpoint is not paginated and takes no filters.\n","tags":["Rules"],"parameters":["66cf10a3-a64c-4ed1-a562-bc05cb26401c"],"responses":{"200":"1bf2fa3e-f5bb-4134-88e8-6cb2f0ad438b"},"security":["26c0a9d7-f785-4cbc-ab98-ccc837b96f85"],"method":"get","type":"path","servers":["251ac026-2e84-49fa-a767-ecd8f38fe60f"],"path":"/networks/customervalue/rules","baseUrlOptions":["https://api.eflow.team/v1"],"title":"List Rules","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"66cf10a3-a64c-4ed1-a562-bc05cb26401c":{"in":"query","name":"relationship","schema":{"type":"string","enum":["event","all"],"description":"Include related data. Use `event` to resolve the display names of the scoped and tied payout/revenue events, or `all` for the same result. Repeat the parameter for multiple values.\n","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Include related data. Use `event` to resolve the display names of the scoped and tied payout/revenue events, or `all` for the same result. Repeat the parameter for multiple values.\n"}},"responses":{"1bf2fa3e-f5bb-4134-88e8-6cb2f0ad438b":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"rules":{"type":"array","items":{"type":"object","properties":{"network_id":{"type":"integer","example":1,"readOnly":true,"description":"Network ID.","uniqueKey":"rules.items.[INDEX].network_id","typeLabel":"integer"},"rule_id":{"type":"integer","example":87,"description":"Unique rule ID. Assigned on creation; required when updating.\n","uniqueKey":"rules.items.[INDEX].rule_id","typeLabel":"integer"},"name":{"type":"string","maxLength":255,"example":"Third purchase bonus","description":"Display name of the rule.","uniqueKey":"rules.items.[INDEX].name","typeLabel":"string"},"status":{"type":"string","enum":["active","inactive"],"default":"active","description":"Whether the rule is enabled. An `inactive` rule never evaluates, whatever its `state`.\n","uniqueKey":"rules.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"state":{"type":"string","enum":["scheduled","running","stopped_running","expired"],"readOnly":true,"description":"Where the rule sits in its lifecycle, derived from its timeframe and configuration. `scheduled` before its start date, `expired` on or after its end date, `stopped_running` when its configuration is no longer valid to apply, and `running` otherwise. The state controls which fields an update can change.\n","uniqueKey":"rules.items.[INDEX].state","typeLabel":"enum\u003cstring>"},"stopped_running_reason":{"type":"string","enum":["default","private_event"],"readOnly":true,"description":"Why the rule is `stopped_running`. `private_event` means the rule defines a payout setting on a scoped event that is private; only revenue may be adjusted in that case.\n","uniqueKey":"rules.items.[INDEX].stopped_running_reason","typeLabel":"enum\u003cstring>"},"segmentation":{"type":"string","enum":["shared","affiliate","offer","advertiser","affiliate_offer","affiliate_advertiser"],"default":"shared","description":"How a customer's accumulated history is partitioned. `shared` tracks one history per customer across everything in scope; the other values track a separate history per partner, per offer, per advertiser, or per combination, so the same customer can progress independently in each.\n","uniqueKey":"rules.items.[INDEX].segmentation","typeLabel":"enum\u003cstring>"},"offer_ids":{"type":"array","items":{"type":"integer","uniqueKey":"rules.items.[INDEX].offer_ids.items.[INDEX]","typeLabel":"integer"},"description":"Offers the rule applies to. Empty means every offer. Mutually exclusive with `advertiser_ids`.\n","uniqueKey":"rules.items.[INDEX].offer_ids","typeLabel":"integer[]"},"advertiser_ids":{"type":"array","items":{"type":"integer","uniqueKey":"rules.items.[INDEX].advertiser_ids.items.[INDEX]","typeLabel":"integer"},"description":"Advertisers the rule applies to, covering all of their offers. Empty means every advertiser. Ignored when `offer_ids` is set.\n","uniqueKey":"rules.items.[INDEX].advertiser_ids","typeLabel":"integer[]"},"affiliate_ids":{"type":"array","items":{"type":"integer","uniqueKey":"rules.items.[INDEX].affiliate_ids.items.[INDEX]","typeLabel":"integer"},"description":"Partners the rule applies to. Empty means every partner.","uniqueKey":"rules.items.[INDEX].affiliate_ids","typeLabel":"integer[]"},"payout_revenue_id":{"type":"integer","description":"Restricts the rule to a single event (payout/revenue entry) of the offer in `offer_ids`. `0` means the rule applies to the offer's base conversion and all of its events.\n","uniqueKey":"rules.items.[INDEX].payout_revenue_id","typeLabel":"integer"},"timezone_id":{"type":"integer","example":67,"description":"Timezone used to interpret `start_date`, `end_date`, and calendar cycle boundaries. Defaults to the network's timezone.\n","uniqueKey":"rules.items.[INDEX].timezone_id","typeLabel":"integer"},"start_date":{"type":"string","example":"2026-08-01","description":"Inclusive start date, `yyyy-MM-dd`. Empty means the rule starts as soon as it is created.\n","uniqueKey":"rules.items.[INDEX].start_date","typeLabel":"string"},"end_date":{"type":"string","example":"2026-12-31","description":"Exclusive end date, `yyyy-MM-dd`. Must be after `start_date`. Empty means the rule never expires.\n","uniqueKey":"rules.items.[INDEX].end_date","typeLabel":"string"},"cycle_type":{"type":"string","enum":["day","week","month","quarter","rule_duration","from_first_conversion"],"default":"rule_duration","description":"When the customer's accumulated totals reset to zero. Calendar cycles (`day`, `week`, `month`, `quarter`) reset on the boundary in the rule's timezone. `rule_duration` never resets — the whole rule is a single cycle. `from_first_conversion` never resets either; instead the rule stops applying to a customer `cycle_duration` days after that customer's first conversion.\n","uniqueKey":"rules.items.[INDEX].cycle_type","typeLabel":"enum\u003cstring>"},"cycle_duration":{"type":"integer","example":30,"description":"Length of the cycle in days. Required and at least `1` when `cycle_type` is `from_first_conversion`; ignored otherwise.\n","uniqueKey":"rules.items.[INDEX].cycle_duration","typeLabel":"integer"},"goals":{"type":"array","description":"Conditions the customer's accumulated totals must satisfy for the outcome to apply, evaluated over the whole history rather than against a single conversion. All goals must be satisfied. A rule may only be goalless when `cycle_type` is `from_first_conversion` and `outcome_type` is `substitution`.\n","items":{"type":"object","required":["metric","operator","value"],"properties":{"metric":{"type":"string","enum":["revenue","payout","sale_amount","conversion","event","data_point"],"description":"What the goal measures. `conversion` counts base conversions and cannot be combined with a `payout_revenue_id` that points to an event; `event` counts events and cannot be used when `payout_revenue_id` points to the base conversion.\n","isRequired":true,"uniqueKey":"rules.items.[INDEX].goals.items.[INDEX].metric","typeLabel":"enum\u003cstring>"},"operator":{"type":"string","enum":["greater_than","less_than","equals","begins_with","ends_with","contains","exact_match"],"description":"Comparison applied to `value`. `greater_than`, `less_than`, and `equals` are numeric; `begins_with`, `ends_with`, `contains`, and `exact_match` are string comparisons.\n","isRequired":true,"uniqueKey":"rules.items.[INDEX].goals.items.[INDEX].operator","typeLabel":"enum\u003cstring>"},"value":{"type":"string","example":"2","description":"The threshold, always sent as a string. Must parse as a number when the operator is numeric, and must be non-empty when the operator is a string comparison.\n","isRequired":true,"uniqueKey":"rules.items.[INDEX].goals.items.[INDEX].value","typeLabel":"string"},"goal_id":{"type":"integer","readOnly":true,"description":"Unique goal ID.","uniqueKey":"rules.items.[INDEX].goals.items.[INDEX].goal_id","typeLabel":"integer"},"metric_data_point_identifier":{"type":"string","description":"Identifier of the data point the goal measures. Required when `metric` is `data_point`; the data point must exist and be `active`.\n","uniqueKey":"rules.items.[INDEX].goals.items.[INDEX].metric_data_point_identifier","typeLabel":"string"},"logic":{"type":"string","enum":["min","max","sum","all","some","current"],"description":"How the data point's values across the cycle are reduced before comparison. Required when `metric` is `data_point`. Use `min`, `max`, or `sum` for numeric data points and `all`, `some`, or `current` for text data points. `current` is not allowed with an `end_of_cycle` outcome trigger.\n","uniqueKey":"rules.items.[INDEX].goals.items.[INDEX].logic","typeLabel":"enum\u003cstring>"}},"uniqueKey":"rules.items.[INDEX].goals.items.[INDEX]","typeLabel":"object"},"uniqueKey":"rules.items.[INDEX].goals","typeLabel":"object[]"},"outcome_type":{"type":"string","enum":["substitution","bonus"],"default":"substitution","description":"How the outcome is applied. Each incoming conversion is added to the customer's history before the goals are checked, so the outcome lands on the conversion being processed when the history first satisfies them. `substitution` replaces that conversion's payout and revenue. `bonus` records a separate bonus conversion on top of it, leaving it untouched.\n","uniqueKey":"rules.items.[INDEX].outcome_type","typeLabel":"enum\u003cstring>"},"outcome_trigger":{"type":"string","enum":["instant","end_of_cycle"],"description":"When a `bonus` outcome is granted. `instant` grants it on the incoming conversion that brought the history to the goals; `end_of_cycle` grants it once when the cycle closes, aggregating the whole cycle. Required when `outcome_type` is `bonus`.\n","uniqueKey":"rules.items.[INDEX].outcome_trigger","typeLabel":"enum\u003cstring>"},"outcome_payout_revenue_id":{"type":"integer","description":"The event the bonus conversion is recorded against. Optional for an `instant` trigger — omit it to tie the bonus to the incoming event — and required for `end_of_cycle`.\n","uniqueKey":"rules.items.[INDEX].outcome_payout_revenue_id","typeLabel":"integer"},"payout_method":{"type":"string","enum":["disabled","modifier","model","data_point"],"description":"How the payout is computed. `disabled` leaves the payout untouched, `modifier` adjusts the original payout, `model` computes a new payout from a payout type, and `data_point` derives it from a numeric data point. At least one of `payout_method` and `revenue_method` must be enabled.\n","uniqueKey":"rules.items.[INDEX].payout_method","typeLabel":"enum\u003cstring>"},"payout_modifier":{"type":"string","enum":["increase","decrease","flat_increase","flat_decrease"],"description":"Direction of the adjustment when `payout_method` is `modifier`. `increase` and `decrease` treat `payout_value` as a percentage; `flat_increase` and `flat_decrease` treat it as an absolute amount.\n","uniqueKey":"rules.items.[INDEX].payout_modifier","typeLabel":"enum\u003cstring>"},"payout_type":{"type":"string","enum":["cpa","cps","cpa_cps","prv","cpm"],"description":"Payout model used when `payout_method` is `model`. Required in that case, and must be `cpa` when `outcome_type` is `bonus`. This is a narrower set than an offer payout type accepts — the `_sku` variants and `cpc` are rejected. Responses return `blank` for any other `payout_method`, which carries no payout type.\n","uniqueKey":"rules.items.[INDEX].payout_type","typeLabel":"enum\u003cstring>"},"payout_value":{"type":"number","format":"double","example":5,"description":"The payout amount, percentage, or per-unit rate, depending on `payout_method`. Cannot be negative, must not exceed `100` for a `decrease` modifier, and must be greater than `0` for `data_point`.\n","uniqueKey":"rules.items.[INDEX].payout_value","typeLabel":"number\u003cdouble>"},"payout_percentage":{"type":"number","format":"double","description":"Percentage of sale amount (`cps`, `cpa_cps`) or of revenue (`prv`) used when `payout_method` is `model`.\n","uniqueKey":"rules.items.[INDEX].payout_percentage","typeLabel":"number\u003cdouble>"},"payout_data_point_identifier":{"type":"string","description":"Identifier of the numeric data point the payout is derived from. Required when `payout_method` is `data_point`; the data point must exist, be `active`, and have type `number`.\n","uniqueKey":"rules.items.[INDEX].payout_data_point_identifier","typeLabel":"string"},"payout_data_point_calculation":{"type":"string","enum":["current","accumulated"],"default":"accumulated","description":"Which value of the data point to use — `current` for the value on the incoming conversion, `accumulated` for the total across the cycle. Defaults to `accumulated`. `current` is not allowed with an `end_of_cycle` outcome trigger.\n","uniqueKey":"rules.items.[INDEX].payout_data_point_calculation","typeLabel":"enum\u003cstring>"},"revenue_method":{"type":"string","enum":["disabled","modifier","model","data_point"],"description":"How the revenue is computed. Mirrors `payout_method`. At least one of `payout_method` and `revenue_method` must be enabled.\n","uniqueKey":"rules.items.[INDEX].revenue_method","typeLabel":"enum\u003cstring>"},"revenue_modifier":{"type":"string","enum":["increase","decrease","flat_increase","flat_decrease"],"description":"Direction of the adjustment when `revenue_method` is `modifier`. Mirrors `payout_modifier`.\n","uniqueKey":"rules.items.[INDEX].revenue_modifier","typeLabel":"enum\u003cstring>"},"revenue_type":{"type":"string","enum":["rpa","rps","rpa_rps","rpm"],"description":"Revenue model used when `revenue_method` is `model`. Required in that case, and must be `rpa` when `outcome_type` is `bonus`. This is a narrower set than an offer revenue type accepts — the `_sku` variants and `rpc` are rejected. Responses return `blank` for any other `revenue_method`, which carries no revenue type.\n","uniqueKey":"rules.items.[INDEX].revenue_type","typeLabel":"enum\u003cstring>"},"revenue_value":{"type":"number","format":"double","example":8,"description":"The revenue amount, percentage, or per-unit rate, depending on `revenue_method`. Same constraints as `payout_value`.\n","uniqueKey":"rules.items.[INDEX].revenue_value","typeLabel":"number\u003cdouble>"},"revenue_percentage":{"type":"number","format":"double","description":"Percentage of sale amount used when `revenue_method` is `model` with `rps` or `rpa_rps`.\n","uniqueKey":"rules.items.[INDEX].revenue_percentage","typeLabel":"number\u003cdouble>"},"revenue_data_point_identifier":{"type":"string","description":"Identifier of the numeric data point the revenue is derived from. Required when `revenue_method` is `data_point`; the data point must exist, be `active`, and have type `number`.\n","uniqueKey":"rules.items.[INDEX].revenue_data_point_identifier","typeLabel":"string"},"revenue_data_point_calculation":{"type":"string","enum":["current","accumulated"],"default":"accumulated","description":"Which value of the data point to use. Mirrors `payout_data_point_calculation`.\n","uniqueKey":"rules.items.[INDEX].revenue_data_point_calculation","typeLabel":"enum\u003cstring>"},"progress_settings":{"type":"array","description":"Exceptions to the cycle reset. Every metric and data point accumulates toward the rule's goals and, by default, resets at the end of each cycle; each entry here names one that carries its total over into the next cycle instead. Each metric may appear at most once. Only meaningful on calendar cycles — a `rule_duration` or `from_first_conversion` cycle never resets.\n","items":{"type":"object","required":["metric","condition"],"properties":{"metric":{"type":"string","enum":["conversions","events","payout","revenue","sale_amount","data_points"],"description":"The metric whose accumulated total carries over.","isRequired":true,"uniqueKey":"rules.items.[INDEX].progress_settings.items.[INDEX].metric","typeLabel":"enum\u003cstring>"},"condition":{"type":"string","enum":["any_value","negative_balance"],"description":"When the carry-over applies. `any_value` always carries the total over, so it never resets. `negative_balance` carries it over only when the total is negative at the cycle boundary — a zero or positive total resets as usual — so a customer left in the red by refunds or chargebacks starts the next cycle still in the red. Text data points have no balance and never carry over under this condition.\n","isRequired":true,"uniqueKey":"rules.items.[INDEX].progress_settings.items.[INDEX].condition","typeLabel":"enum\u003cstring>"},"setting_id":{"type":"integer","readOnly":true,"description":"Unique progress setting ID.","uniqueKey":"rules.items.[INDEX].progress_settings.items.[INDEX].setting_id","typeLabel":"integer"},"data_point_identifier":{"type":"string","description":"Identifier of the data point whose accumulated total carries over. Required when `metric` is `data_points`; the data point must exist and be `active`. Each data point may appear at most once.\n","uniqueKey":"rules.items.[INDEX].progress_settings.items.[INDEX].data_point_identifier","typeLabel":"string"}},"uniqueKey":"rules.items.[INDEX].progress_settings.items.[INDEX]","typeLabel":"object"},"uniqueKey":"rules.items.[INDEX].progress_settings","typeLabel":"object[]"},"relationship":{"type":"object","readOnly":true,"description":"Related data, returned only when requested with the `relationship` query parameter.\n","properties":{"scoped_payout_revenue_name":{"type":"string","description":"Display name of the event in `payout_revenue_id`. `Base` for the offer's base conversion.\n","uniqueKey":"rules.items.[INDEX].relationship.scoped_payout_revenue_name","typeLabel":"string"},"tied_payout_revenue_name":{"type":"string","description":"Display name of the event in `outcome_payout_revenue_id`.\n","uniqueKey":"rules.items.[INDEX].relationship.tied_payout_revenue_name","typeLabel":"string"}},"uniqueKey":"rules.items.[INDEX].relationship","typeLabel":"object"},"time_created":{"type":"integer","example":1734455015,"readOnly":true,"description":"Unix timestamp of creation.","uniqueKey":"rules.items.[INDEX].time_created","typeLabel":"integer"},"time_saved":{"type":"integer","example":1734455015,"readOnly":true,"description":"Unix timestamp of last update.","uniqueKey":"rules.items.[INDEX].time_saved","typeLabel":"integer"}},"uniqueKey":"rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"rules","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"rules":[{"network_id":1,"rule_id":87,"name":"Third purchase bonus","status":"active","state":"scheduled","stopped_running_reason":"default","segmentation":"shared","offer_ids":[123],"advertiser_ids":[123],"affiliate_ids":[123],"payout_revenue_id":123,"timezone_id":67,"start_date":"2026-08-01","end_date":"2026-12-31","cycle_type":"rule_duration","cycle_duration":30,"goals":[{"metric":"revenue","operator":"greater_than","value":"2","goal_id":123,"metric_data_point_identifier":"\u003cstring>","logic":"min"}],"outcome_type":"substitution","outcome_trigger":"instant","outcome_payout_revenue_id":123,"payout_method":"disabled","payout_modifier":"increase","payout_type":"cpa","payout_value":5,"payout_percentage":123,"payout_data_point_identifier":"\u003cstring>","payout_data_point_calculation":"accumulated","revenue_method":"disabled","revenue_modifier":"increase","revenue_type":"rpa","revenue_value":8,"revenue_percentage":123,"revenue_data_point_identifier":"\u003cstring>","revenue_data_point_calculation":"accumulated","progress_settings":[{"metric":"conversions","condition":"any_value","setting_id":123,"data_point_identifier":"\u003cstring>"}],"relationship":{"scoped_payout_revenue_name":"\u003cstring>","tied_payout_revenue_name":"\u003cstring>"},"time_created":1734455015,"time_saved":1734455015}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"26c0a9d7-f785-4cbc-ab98-ccc837b96f85":{"API Key":{"description":"The Everflow API key generated from the Control Center > Security.","in":"header","name":"X-Eflow-Api-Key","type":"apiKey","scopes":[]}}},"servers":{"251ac026-2e84-49fa-a767-ecd8f38fe60f":{"url":"https://api.eflow.team/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"The Everflow API key generated from the Control Center > Security.","in":"header","name":"X-Eflow-Api-Key","type":"apiKey","scopes":[]},"schema":{"title":"X-Eflow-Api-Key","type":"string","description":"The Everflow API key generated from the Control Center > Security.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"API Key","name":"X-Eflow-Api-Key"}],"title":"API Key"}]},"originalFileLocation":"openapi/customer-value.yaml"},"subdomain":"everflowtechnologies","siteName":"Everflow API","title":"List Rules - Everflow API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-16T15:08:19.041Z","originalFileLocation":"api-reference/get-networkscustomervaluerules.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve every Customer Value rule defined for the network. This endpoint is not paginated and takes no filters.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Everflow API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/everflowtechnologies/y-u2HIUWLVaXRWZd/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/everflowtechnologies/y-u2HIUWLVaXRWZd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/everflowtechnologies/y-u2HIUWLVaXRWZd/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/everflowtechnologies/y-u2HIUWLVaXRWZd/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/everflowtechnologies/y-u2HIUWLVaXRWZd/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/everflowtechnologies/y-u2HIUWLVaXRWZd/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/everflowtechnologies/y-u2HIUWLVaXRWZd/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/everflowtechnologies/y-u2HIUWLVaXRWZd/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/everflowtechnologies/y-u2HIUWLVaXRWZd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Rules - Everflow API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve every Customer Value rule defined for the network. This endpoint is not paginated and takes no filters.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Everflow API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.everflow.io/api-reference/get-networkscustomervaluerules\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://everflowtechnologies.mintlify.app/_mintlify/api/og/v2?division=Rules\u0026amp;title=List+Rules\u0026amp;description=Retrieve+every+Customer+Value+rule+defined+for+the+network.+This+endpoint+is+not+paginated+and+takes+no+filters.%0A\u0026amp;theme=b2adfc48486e47966d246ed6\u0026amp;signature=b31fd3caf573bdc14c9108f1eec7c49df2303ca62377cfca114f7e8d49465b69\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List Rules - Everflow API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve every Customer Value rule defined for the network. This endpoint is not paginated and takes no filters.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://everflowtechnologies.mintlify.app/_mintlify/api/og/v2?division=Rules\u0026amp;title=List+Rules\u0026amp;description=Retrieve+every+Customer+Value+rule+defined+for+the+network.+This+endpoint+is+not+paginated+and+takes+no+filters.%0A\u0026amp;theme=b2adfc48486e47966d246ed6\u0026amp;signature=b31fd3caf573bdc14c9108f1eec7c49df2303ca62377cfca114f7e8d49465b69\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/everflowtechnologies/y-u2HIUWLVaXRWZd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Everflow API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4332a5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.everflow.io/api-reference/get-networkscustomervaluerules\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/get-networkscustomervaluerules.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.everflow.io/#organization\",\"name\":\"Everflow API\",\"url\":\"https://developers.everflow.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/everflowtechnologies/vVJLGBUt_z0g35hz/logo/everflow.png?fit=max\u0026auto=format\u0026n=vVJLGBUt_z0g35hz\u0026q=85\u0026s=437ab9116ac53bbfd222d2fd57a4af08\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.everflow.io#website\",\"name\":\"Everflow API\",\"url\":\"https://developers.everflow.io\",\"publisher\":{\"@id\":\"https://developers.everflow.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.everflow.io/api-reference/get-networkscustomervaluerules#webpage\",\"url\":\"https://developers.everflow.io/api-reference/get-networkscustomervaluerules\",\"name\":\"List Rules\",\"description\":\"Retrieve every Customer Value rule defined for the network. This endpoint is not paginated and takes no filters.\",\"dateModified\":\"2026-09-16T15:08:19.041Z\",\"isPartOf\":{\"@id\":\"https://developers.everflow.io#website\"},\"breadcrumb\":{\"@id\":\"https://developers.everflow.io/api-reference/get-networkscustomervaluerules#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.everflow.io/api-reference/get-networkscustomervaluerules#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Network API\",\"item\":\"https://developers.everflow.io/api-reference/network-overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customer Value\",\"item\":\"https://developers.everflow.io/api-reference/customer-value-overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Rules\",\"item\":\"https://developers.everflow.io/api-reference/post-networkscustomervaluerules\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"List Rules\",\"item\":\"https://developers.everflow.io/api-reference/get-networkscustomervaluerules\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.everflow.io/api-reference/get-networkscustomervaluerules#apireference\",\"headline\":\"List Rules\",\"name\":\"List Rules\",\"description\":\"Retrieve every Customer Value rule defined for the network. This endpoint is not paginated and takes no filters.\",\"url\":\"https://developers.everflow.io/api-reference/get-networkscustomervaluerules\",\"mainEntityOfPage\":{\"@id\":\"https://developers.everflow.io/api-reference/get-networkscustomervaluerules#webpage\"},\"dateModified\":\"2026-09-16T15:08:19.041Z\",\"publisher\":{\"@id\":\"https://developers.everflow.io/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.everflow.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Everflow API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Everflow API","nav":{"global":{},"tabs":[{"tab":"User Guide","pages":[{"title":"User Guide","href":"/user-guide/quickstart"}]},{"tab":"Network API","groups":[{"group":"Network API","pages":[{"title":"Network API","sidebarTitle":"Overview","href":"/api-reference/network-overview"},{"group":"Global Search","expanded":false,"pages":[{"title":"Global Search","openapi":"openapi/network-meta.yaml get /networks/search/meta","href":"/api-reference/get-networksmetasearch"}]},{"group":"Advertiser Users","expanded":false,"pages":[{"title":"Create Advertiser User","openapi":"openapi/advertiser-users.yaml post /networks/advertisers/{advertiserId}/users","href":"/api-reference/post-networksadvertiserusers"},{"title":"Update Advertiser User","openapi":"openapi/advertiser-users.yaml put /networks/advertisers/{advertiserId}/users/{userId}","href":"/api-reference/put-networksadvertiseruser"},{"title":"List Advertiser Users by Advertiser","openapi":"openapi/advertiser-users.yaml get /networks/advertisers/{advertiserId}/users","href":"/api-reference/get-networksadvertiserusersbyid"},{"title":"Get Advertiser User","openapi":"openapi/advertiser-users.yaml get /networks/advertisers/{advertiserId}/users/{userId}","href":"/api-reference/get-networksadvertiseruser"}]},{"group":"Advertisers","expanded":false,"pages":[{"title":"Create Advertiser","openapi":"openapi/advertisers.yaml post /networks/advertisers","href":"/api-reference/post-networksadvertisers"},{"title":"Update Advertiser","openapi":"openapi/advertisers.yaml put /networks/advertisers/{advertiserId}","href":"/api-reference/put-networksadvertiser"},{"title":"Get Advertiser by ID","openapi":"openapi/advertisers.yaml get /networks/advertisers/{advertiserId}","href":"/api-reference/get-networksadvertiser"},{"title":"Find Advertisers (Advanced)","openapi":"openapi/advertisers.yaml post /networks/advertiserstable","href":"/api-reference/post-networksadvertiserstable"},{"title":"List Advertiser Events","openapi":"openapi/advertisers.yaml get /networks/advertisers/{advertiserId}/events","href":"/api-reference/get-networksadvertiserevents"},{"title":"Advertiser Bulk Edit Preview","openapi":"openapi/advertisers-extras.yaml post /networks/patch/advertiser/submit","href":"/api-reference/post-networkspatchadvertisersubmit"},{"title":"Apply Advertiser Bulk Edit","openapi":"openapi/advertisers-extras.yaml patch /networks/patch/advertiser/apply","href":"/api-reference/patch-networkspatchadvertiserapply"}]},{"group":"Affiliate Tiers","expanded":false,"pages":[{"title":"Create Affiliate Tier","openapi":"openapi/affiliate-tiers.yaml post /networks/affiliatetiers","href":"/api-reference/post-networksaffiliatetiers"},{"title":"Update Affiliate Tier","openapi":"openapi/affiliate-tiers.yaml put /networks/affiliatetiers/{affiliateTierId}","href":"/api-reference/put-networksaffiliatetier"},{"title":"Get Affiliate Tier","openapi":"openapi/affiliate-tiers.yaml get /networks/affiliatetiers/{affiliateTierId}","href":"/api-reference/get-networksaffiliatetier"},{"title":"List Affiliate Tiers","openapi":"openapi/affiliate-tiers.yaml get /networks/affiliatetiers","href":"/api-reference/get-networksaffiliatetiers"}]},{"group":"Affiliate Tracking Domains","expanded":false,"pages":[{"title":"List Tracking Domains","openapi":"openapi/tracking-domains.yaml get /networks/domains/tracking","href":"/api-reference/get-networkstrackingdomains"},{"title":"Get Tracking Domain","openapi":"openapi/tracking-domains.yaml get /networks/domains/tracking/{domainId}","href":"/api-reference/get-networkstrackingdomain"},{"title":"List Affiliate Tracking Domains","openapi":"openapi/tracking-domains.yaml get /networks/affiliates/{affiliateId}/trackingdomains","href":"/api-reference/get-networksaffiliatetrackingdomains"},{"title":"Delete Affiliate Tracking Domain","openapi":"openapi/tracking-domains.yaml delete /networks/affiliates/{affiliateId}/trackingdomains/{affiliateTrackingDomainId}","href":"/api-reference/delete-networksaffiliatetrackingdomain"},{"title":"Get Affiliate Tracking Domain","openapi":"openapi/tracking-domains.yaml get /networks/affiliates/{affiliateId}/trackingdomains/{affiliateTrackingDomainId}","href":"/api-reference/get-networksaffiliatetrackingdomain"},{"title":"Create Affiliate Tracking Domain","openapi":"openapi/tracking-domains.yaml post /networks/affiliates/{affiliateId}/trackingdomains","href":"/api-reference/post-networksaffiliatetrackingdomains"},{"title":"Update Affiliate Tracking Domain","openapi":"openapi/tracking-domains.yaml put /networks/affiliates/{affiliateId}/trackingdomains","href":"/api-reference/put-networksaffiliatetrackingdomains"}]},{"group":"Affiliate Users","expanded":false,"pages":[{"title":"Create Affiliate User","openapi":"openapi/affiliate-users.yaml post /networks/affiliates/{affiliateId}/users","href":"/api-reference/post-networksaffiliateusers"},{"title":"Update Affiliate User","openapi":"openapi/affiliate-users.yaml put /networks/affiliates/{affiliateId}/users/{userId}","href":"/api-reference/put-networksaffiliateuser"},{"title":"Get Affiliate User","openapi":"openapi/affiliate-users.yaml get /networks/affiliates/{affiliateId}/users/{userId}","href":"/api-reference/get-networksaffiliateuser"},{"title":"List Affiliate Users","openapi":"openapi/affiliate-users.yaml get /networks/affiliates/{affiliateId}/users","href":"/api-reference/get-networksaffiliateusersby"}]},{"group":"Affiliates","expanded":false,"pages":[{"title":"Create Affiliate","openapi":"openapi/affiliates.yaml post /networks/affiliates","href":"/api-reference/post-networksaffiliates"},{"title":"Update Affiliate","openapi":"openapi/affiliates.yaml put /networks/affiliates/{affiliateId}","href":"/api-reference/put-networksaffiliate"},{"title":"Process Pending Affiliates","openapi":"openapi/affiliates.yaml patch /networks/pending/affiliates","href":"/api-reference/patch-networksaffiliatespending"},{"title":"Get Affiliate by ID","openapi":"openapi/affiliates.yaml get /networks/affiliates/{affiliateId}","href":"/api-reference/get-networksaffiliate"},{"title":"Find Affiliates (Advanced)","openapi":"openapi/affiliates.yaml post /networks/affiliatestable","href":"/api-reference/post-networksaffiliatestable"},{"title":"Affiliate Bulk Edit Preview","openapi":"openapi/affiliates-extras.yaml post /networks/patch/affiliates/submit","href":"/api-reference/post-networksaffiliatespatchsubmit"},{"title":"Apply Affiliate Bulk Edit","openapi":"openapi/affiliates-extras.yaml patch /networks/patch/affiliates/apply","href":"/api-reference/patch-networkspatchaffiliatesapply"}]},{"group":"Business Units","expanded":false,"pages":[{"title":"List Business Units","openapi":"openapi/business-units.yaml get /networks/businessunits","href":"/api-reference/get-networksbusinessunits"},{"title":"Get Business Unit","openapi":"openapi/business-units.yaml get /networks/businessunits/{businessUnitId}","href":"/api-reference/get-networksbusinessunit"},{"title":"Create Business Unit","openapi":"openapi/business-units.yaml post /networks/businessunits","href":"/api-reference/post-networksbusinessunits"},{"title":"Update Business Unit","openapi":"openapi/business-units.yaml put /networks/businessunits/{businessUnitId}","href":"/api-reference/put-networksbusinessunit"}]},{"group":"Categories","expanded":false,"pages":[{"title":"Create Category","openapi":"openapi/categories.yaml post /networks/categories","href":"/api-reference/post-networkscategories"},{"title":"Update Category","openapi":"openapi/categories.yaml put /networks/categories/{categoryId}","href":"/api-reference/put-networkscategory"},{"title":"Get Category","openapi":"openapi/categories.yaml get /networks/categories/{categoryId}","href":"/api-reference/get-networkscategory"},{"title":"List Categories","openapi":"openapi/categories.yaml get /networks/categories","href":"/api-reference/get-networkscategories"}]},{"group":"Channels","expanded":false,"pages":[{"title":"Create Channel","openapi":"openapi/channels.yaml post /networks/channels","href":"/api-reference/post-networkschannels"},{"title":"List Channels","openapi":"openapi/channels.yaml get /networks/channels","href":"/api-reference/get-networkschannels"},{"title":"Delete Channel","openapi":"openapi/channels.yaml delete /networks/channels/{channelId}","href":"/api-reference/delete-networkschannel"},{"title":"Get Channel","openapi":"openapi/channels.yaml get /networks/channels/{channelId}","href":"/api-reference/get-networkschannel"},{"title":"Update Channel","openapi":"openapi/channels.yaml put /networks/channels/{channelId}","href":"/api-reference/put-networkschannel"}]},{"group":"Conversion Updates","expanded":false,"pages":[{"title":"Update Conversion Payout \u0026 Revenue","openapi":"openapi/reporting-conversions.yaml put /networks/reporting/conversions/{conversionId}/payoutrevenue","href":"/api-reference/put-networksreportingconversionspayoutrevenue"},{"title":"Update Conversion Status","openapi":"openapi/reporting-conversions.yaml patch /networks/reporting/conversions","href":"/api-reference/patch-networksreportingconversions"},{"title":"Update Conversion Sale Amount","openapi":"openapi/reporting-conversions.yaml put /networks/reporting/conversions/{conversionId}/saleamount","href":"/api-reference/put-networksreportingconversionssaleamount"},{"title":"Update Conversion Notes","openapi":"openapi/reporting-conversions.yaml put /networks/reporting/conversions/{conversionId}/notes","href":"/api-reference/put-networksreportingconversionsnotes"},{"title":"Upload Conversions CSV","openapi":"openapi/reporting-conversions.yaml post /networks/reporting/upload/conversions","href":"/api-reference/post-networksreportinguploadconversions"},{"title":"Create Conversions with Transaction IDs","openapi":"openapi/reporting-conversions.yaml post /networks/conversions/reporting/transaction_ids","href":"/api-reference/post-networksconversionsreportingtransactionids"},{"title":"Create Conversions without Transaction IDs","openapi":"openapi/reporting-conversions.yaml post /networks/conversions/reporting","href":"/api-reference/post-networksconversionsreporting"},{"title":"Update On-Hold Conversion Status","openapi":"openapi/reporting-onhold.yaml patch /networks/reporting/onhold","href":"/api-reference/patch-networksreportingonholdconversions"}]},{"group":"Coupon Codes","expanded":false,"pages":[{"title":"Create Coupon Code","openapi":"openapi/coupon-codes.yaml post /networks/couponcodes","href":"/api-reference/post-networkscouponcodes"},{"title":"Update Coupon Code","openapi":"openapi/coupon-codes.yaml put /networks/couponcodes/{couponCodeId}","href":"/api-reference/put-networkscouponcode"},{"title":"Get Coupon Code","openapi":"openapi/coupon-codes.yaml get /networks/couponcodes/{couponCodeId}","href":"/api-reference/get-networkscouponcode"},{"title":"List Coupon Codes","openapi":"openapi/coupon-codes.yaml get /networks/couponcodes","href":"/api-reference/get-networkscouponcodes"},{"title":"Delete Coupon Code","openapi":"openapi/coupon-codes.yaml delete /networks/couponcodes/{couponCodeId}","href":"/api-reference/delete-networkscouponcode"}]},{"group":"Creatives","expanded":false,"pages":[{"title":"Create Creative","openapi":"openapi/creatives.yaml post /networks/creatives","href":"/api-reference/post-networkscreatives"},{"title":"Update Creative","openapi":"openapi/creatives.yaml put /networks/creatives/{creativeId}","href":"/api-reference/put-networkscreative"},{"title":"Get Creative","openapi":"openapi/creatives.yaml get /networks/creatives/{creativeId}","href":"/api-reference/get-networkscreative"},{"title":"Find Creatives (Advanced)","openapi":"openapi/creatives.yaml post /networks/creativestable","href":"/api-reference/post-networkscreativestable"},{"title":"Apply Creative Bulk Edit","openapi":"openapi/creatives.yaml patch /networks/patch/offers/creative/apply","href":"/api-reference/patch-networkscreativesapply"}]},{"group":"Custom Caps","expanded":false,"pages":[{"title":"Create Custom Cap","openapi":"openapi/custom-caps.yaml post /networks/custom/caps","href":"/api-reference/post-networkscustomcaps"},{"title":"Bulk Update Custom Caps","openapi":"openapi/custom-caps.yaml patch /networks/custom/caps","href":"/api-reference/patch-networkscustomcaps"},{"title":"Get Custom Cap","openapi":"openapi/custom-caps.yaml get /networks/custom/caps/{settingId}","href":"/api-reference/get-networkscustomcap"},{"title":"List Custom Caps","openapi":"openapi/custom-caps.yaml get /networks/custom/caps","href":"/api-reference/get-networkscustomcaps"},{"title":"Find Custom Caps (Advanced)","openapi":"openapi/custom-caps.yaml post /networks/custom/capstable","href":"/api-reference/post-networkscustomcapstable"},{"title":"Delete Custom Cap","openapi":"openapi/custom-caps.yaml delete /networks/custom/caps/{settingId}","href":"/api-reference/delete-networkscustomcap"}]},{"group":"Custom Landing Pages","expanded":false,"pages":[{"title":"Find Custom Landing Pages (Advanced)","openapi":"openapi/custom-landing-pages.yaml post /networks/custom/landingpages/table","href":"/api-reference/post-networkscustomlandingpagetable"},{"title":"Create Custom Landing Page Setting","openapi":"openapi/custom-landing-pages.yaml post /networks/custom/landingpages","href":"/api-reference/post-networkscustomlandingpage"},{"title":"Update Custom Landing Page Setting","openapi":"openapi/custom-landing-pages.yaml put /networks/custom/landingpages/{settingId}","href":"/api-reference/put-networkscustomlandingpage"},{"title":"Delete Custom Landing Page","openapi":"openapi/custom-landing-pages.yaml delete /networks/custom/landingpages/{settingId}","href":"/api-reference/delete-networkscustomlandingpage"}]},{"group":"Custom Creatives","expanded":false,"pages":[{"title":"Find Custom Creative Settings (Advanced)","openapi":"openapi/custom-creatives-settings.yaml post /networks/custom/creativetable","href":"/api-reference/post-networkscustomcreativetable"},{"title":"Create Custom Creative Setting","openapi":"openapi/custom-creatives-settings.yaml post /networks/custom/creative","href":"/api-reference/post-networkscustomcreative"},{"title":"Update Custom Creative Setting","openapi":"openapi/custom-creatives-settings.yaml put /networks/custom/creative/{settingId}","href":"/api-reference/put-networkscustomcreativesetting"},{"title":"Bulk Update Custom Creative Status","openapi":"openapi/custom-creatives-settings.yaml patch /networks/custom/creative","href":"/api-reference/patch-networkscustomcreative"},{"title":"Get Custom Creative Setting","openapi":"openapi/custom-creatives-settings.yaml get /networks/custom/creative/{settingId}","href":"/api-reference/get-networkscustomcreativesetting"},{"title":"List Custom Creative Settings","openapi":"openapi/custom-creatives-settings.yaml get /networks/custom/creative","href":"/api-reference/get-networkscustomcreative"},{"title":"Delete Custom Creative Setting","openapi":"openapi/custom-creatives-settings.yaml delete /networks/custom/creative/{settingId}","href":"/api-reference/delete-networkscustomcreativesetting"}]},{"group":"Custom Payout \u0026 Revenues","expanded":false,"pages":[{"title":"Find Custom Payout \u0026 Revenues (Advanced)","openapi":"openapi/custom-payout-revenue.yaml post /networks/custom/payoutrevenuetable","href":"/api-reference/post-networkscustompayoutrevenuetable"},{"title":"Create Custom Payout/Revenue","openapi":"openapi/custom-payout-revenue.yaml post /networks/custom/payoutrevenue","href":"/api-reference/post-networkscustompayoutrevenue"},{"title":"Update Custom Payout/Revenue","openapi":"openapi/custom-payout-revenue.yaml put /networks/custom/payoutrevenue/{settingId}","href":"/api-reference/put-networkscustompayoutrevenuesetting"},{"title":"Bulk Update Custom Payout/Revenue","openapi":"openapi/custom-payout-revenue.yaml patch /networks/custom/payoutrevenue","href":"/api-reference/patch-networkscustompayoutrevenue"},{"title":"Get Custom Payout/Revenue","openapi":"openapi/custom-payout-revenue.yaml get /networks/custom/payoutrevenue/{settingId}","href":"/api-reference/get-networkscustompayoutrevenuesetting"},{"title":"Delete Custom Payout/Revenue","openapi":"openapi/custom-payout-revenue.yaml delete /networks/custom/payoutrevenue/{settingId}","href":"/api-reference/delete-networkscustompayoutrevenuesetting"}]},{"group":"Custom Scrub Rates (Throttle)","expanded":false,"pages":[{"title":"Create Custom Scrub Rate","openapi":"openapi/custom-scrub-rates.yaml post /networks/custom/scrubrate","href":"/api-reference/post-networkscustomscrubrate"},{"title":"Update Custom Scrub Rate","openapi":"openapi/custom-scrub-rates.yaml put /networks/custom/scrubrate/{settingId}","href":"/api-reference/put-networkscustomscrubrate"},{"title":"Get Custom Scrub Rate","openapi":"openapi/custom-scrub-rates.yaml get /networks/custom/scrubrate/{settingId}","href":"/api-reference/get-networkscustomscrubrate"},{"title":"Find Custom Scrub Rates (Advanced)","openapi":"openapi/custom-scrub-rates.yaml post /networks/custom/scrubratetable","href":"/api-reference/post-networkscustomscrubratetable"},{"title":"Delete Custom Scrub Rate","openapi":"openapi/custom-scrub-rates.yaml delete /networks/custom/scrubrate/{settingId}","href":"/api-reference/delete-networkscustomscrubrate"}]},{"group":"Customer Value","expanded":false,"pages":[{"title":"Customer Value","sidebarTitle":"Overview","href":"/api-reference/customer-value-overview"},{"group":"Data Points","pages":[{"title":"Create Data Point","openapi":"openapi/customer-value.yaml post /networks/customervalue/datapoints","href":"/api-reference/post-networkscustomervaluedatapoints"},{"title":"Update Data Point","openapi":"openapi/customer-value.yaml put /networks/customervalue/datapoints","href":"/api-reference/put-networkscustomervaluedatapoints"},{"title":"Get Data Point","openapi":"openapi/customer-value.yaml get /networks/customervalue/datapoints/{dataPointId}","href":"/api-reference/get-networkscustomervaluedatapoint"},{"title":"List Data Points","openapi":"openapi/customer-value.yaml get /networks/customervalue/datapoints","href":"/api-reference/get-networkscustomervaluedatapoints"},{"title":"Delete Data Point","openapi":"openapi/customer-value.yaml delete /networks/customervalue/datapoints/{dataPointId}","href":"/api-reference/delete-networkscustomervaluedatapoint"}]},{"group":"Rules","pages":[{"title":"Create Rule","openapi":"openapi/customer-value.yaml post /networks/customervalue/rules","href":"/api-reference/post-networkscustomervaluerules"},{"title":"Update Rule","openapi":"openapi/customer-value.yaml put /networks/customervalue/rules","href":"/api-reference/put-networkscustomervaluerules"},{"title":"Get Rule","openapi":"openapi/customer-value.yaml get /networks/customervalue/rules/{ruleId}","description":"Retrieve a single Customer Value rule by its ID.","href":"/api-reference/get-networkscustomervaluerule"},{"title":"List Rules","openapi":"openapi/customer-value.yaml get /networks/customervalue/rules","href":"/api-reference/get-networkscustomervaluerules"},{"title":"Delete Rule","openapi":"openapi/customer-value.yaml delete /networks/customervalue/rules/{ruleId}","description":"Delete a Customer Value rule. Deletion is permanent and removes the rule regardless of its state. To stop a rule while keeping it, set its `status` to `inactive` instead.\n","href":"/api-reference/delete-networkscustomervaluerule"}]}]},{"group":"Data Supplements","expanded":false,"pages":[{"title":"Create Data Supplement","openapi":"openapi/data-supplements.yaml post /networks/supplements","href":"/api-reference/post-networkssupplements"},{"title":"Revert Data Supplements","openapi":"openapi/data-supplements.yaml post /networks/supplements/revert","href":"/api-reference/post-networkssupplementsrevert"},{"title":"List Data Supplements","openapi":"openapi/data-supplements.yaml post /networks/supplements/table","href":"/api-reference/post-networkssupplementstable"},{"title":"Export Data Supplements","openapi":"openapi/data-supplements.yaml post /networks/supplements/table/stream","href":"/api-reference/post-networkssupplementstablestream"}]},{"group":"Encoding / Decoding","expanded":false,"pages":[{"title":"Encode IDs","openapi":"openapi/utilities.yaml post /networks/encode","href":"/api-reference/post-networksencode"},{"title":"Decode IDs","openapi":"openapi/utilities.yaml post /networks/decode","href":"/api-reference/post-networksdecode"}]},{"group":"Invoices","expanded":false,"pages":[{"title":"Create Partner Invoice","openapi":"openapi/network-billing.yaml post /networks/billings/affiliates/invoices","href":"/api-reference/post-networksbillingsinvoices"},{"title":"Get Partner Invoice","openapi":"openapi/network-billing.yaml get /networks/billings/affiliates/invoices/{invoiceId}","href":"/api-reference/get-networksbillingsinvoice"},{"title":"Find Partner Invoices (Advanced)","openapi":"openapi/network-billing.yaml post /networks/billings/affiliates/invoicestable","href":"/api-reference/post-networksbillingsinvoicestable"},{"title":"Get Invoice Summary","openapi":"openapi/network-billing.yaml post /networks/billings/affiliates/summary","href":"/api-reference/post-networksbillingssummary"}]},{"group":"Labels","expanded":false,"pages":[{"title":"Create Label","openapi":"openapi/labels.yaml post /networks/labels","href":"/api-reference/post-networkslabels"},{"title":"Get Label","openapi":"openapi/labels.yaml get /networks/labels/{label}","href":"/api-reference/get-networkslabel"},{"title":"List Labels","openapi":"openapi/labels.yaml get /networks/labels","href":"/api-reference/get-networkslabels"},{"title":"Delete Label","openapi":"openapi/labels.yaml delete /networks/labels","href":"/api-reference/delete-networkslabel"},{"title":"Update Label","openapi":"openapi/labels.yaml put /networks/labels","href":"/api-reference/put-networkslabels"}]},{"group":"Offer Groups","expanded":false,"pages":[{"title":"Create Offer Group","openapi":"openapi/offer-groups.yaml post /networks/offergroups","href":"/api-reference/post-networksoffergroups"},{"title":"Update Offer Group","openapi":"openapi/offer-groups.yaml put /networks/offergroups/{offerGroupId}","href":"/api-reference/put-networksoffergroup"},{"title":"Get Offer Group","openapi":"openapi/offer-groups.yaml get /networks/offergroups/{offerGroupId}","href":"/api-reference/get-networksoffergroup"},{"title":"Get All Offer Groups","openapi":"openapi/offer-groups.yaml get /networks/offergroups","href":"/api-reference/get-networksoffergroups"},{"title":"Find Offer Groups (Advanced)","openapi":"openapi/offer-groups-extras.yaml post /networks/offergroupstable","href":"/api-reference/post-networksoffergroupstable"}]},{"group":"Offer URLs","expanded":false,"pages":[{"title":"Find Offer URLs (Advanced)","openapi":"openapi/offer-urls.yaml post /networks/offerurls/table","href":"/api-reference/post-networksofferurlstable"},{"title":"Create Offer URL","openapi":"openapi/offer-urls.yaml post /networks/offerurls","href":"/api-reference/post-networksofferurls"},{"title":"Update Offer URL","openapi":"openapi/offer-urls.yaml put /networks/offerurls/{offerUrlId}","href":"/api-reference/put-networksofferurl"},{"title":"Apply Offer URL Bulk Edit","openapi":"openapi/offer-urls.yaml patch /networks/patch/offerurls/apply","href":"/api-reference/patch-networksofferurlsapply"},{"title":"Get Offer URL","openapi":"openapi/offer-urls.yaml get /networks/offerurls/{offerUrlId}","href":"/api-reference/get-networksofferurl"},{"title":"List Offer URLs","openapi":"openapi/offer-urls.yaml get /networks/offerurls","href":"/api-reference/get-networksofferurls"},{"title":"Bulk Create Offer URLs","openapi":"openapi/offer-urls.yaml post /networks/offerurls/bulk","href":"/api-reference/post-networksofferurlsbulk"}]},{"group":"Offer Visibility","expanded":false,"pages":[{"title":"Set Offer Visibility","openapi":"openapi/offer-visibility.yaml put /networks/offers/{offerId}/visibility","href":"/api-reference/put-networksoffervisibility"},{"title":"Update Affiliate Offer Visibility","openapi":"openapi/offer-visibility.yaml patch /networks/affiliates/{affiliateId}/offers/visibility","href":"/api-reference/patch-networksaffiliateoffervisibility"},{"title":"Get Offer Visibility","openapi":"openapi/offer-visibility.yaml get /networks/offers/{offerId}/visibility","href":"/api-reference/get-networksoffervisibility"}]},{"group":"Offers","expanded":false,"pages":[{"title":"Create Offer","openapi":"openapi/offers.yaml post /networks/offers","href":"/api-reference/post-networksoffers"},{"title":"Update Offer","openapi":"openapi/offers.yaml put /networks/offers/{offerId}","href":"/api-reference/put-networksoffer"},{"title":"Apply Offer Bulk Edit","openapi":"openapi/offers-extras.yaml patch /networks/patch/offers/apply","href":"/api-reference/patch-networksofferspatch"},{"title":"Get Offer by ID","openapi":"openapi/offers.yaml get /networks/offers/{offerId}","href":"/api-reference/get-networksoffer"},{"title":"Find Offers (Advanced)","openapi":"openapi/offers.yaml post /networks/offerstable","href":"/api-reference/post-networksofferstable"},{"title":"Copy Offer","openapi":"openapi/offers-extras.yaml get /networks/offers/{offerId}/copy","href":"/api-reference/get-networksofferscopy"},{"title":"Offer Bulk Edit Preview","openapi":"openapi/offers-extras.yaml post /networks/patch/offers/submit","href":"/api-reference/post-networksofferspatchsubmit"},{"title":"Export Offers","openapi":"openapi/offers-extras.yaml post /networks/export/offers","href":"/api-reference/post-networksexportoffers"}]},{"group":"Partner Postbacks","expanded":false,"pages":[{"title":"Create Partner Postback","openapi":"openapi/partner-postbacks.yaml post /networks/pixels","href":"/api-reference/post-networkspixels"},{"title":"Update Partner Postback","openapi":"openapi/partner-postbacks.yaml put /networks/pixels/{pixelId}","href":"/api-reference/put-networkspixel"},{"title":"Get Partner Postback","openapi":"openapi/partner-postbacks.yaml get /networks/pixels/{pixelId}","href":"/api-reference/get-networkspixel"},{"title":"Find Partner Postbacks (Advanced)","openapi":"openapi/partner-postbacks.yaml post /networks/pixelstable","href":"/api-reference/post-networkspixelstable"},{"title":"Delete Partner Postback","openapi":"openapi/partner-postbacks-extras.yaml delete /networks/pixels/{pixelId}","href":"/api-reference/delete-networkspixel"}]},{"group":"Reporting","expanded":false,"pages":[{"group":"Adjustments","pages":[{"title":"Find Adjustments (Advanced)","openapi":"openapi/reporting-adjustments.yaml post /networks/reportingadjustments/table","href":"/api-reference/post-networksreportingadjustmentstable"},{"title":"Search Reporting Adjustments","openapi":"openapi/reporting-adjustments.yaml get /networks/reportingadjustments","href":"/api-reference/get-networksreportingadjustments"}]},{"group":"Aggregated Data","pages":[{"title":"Get Aggregated Reporting Data","openapi":"openapi/reporting-aggregated.yaml post /networks/reporting/entity/table","href":"/api-reference/post-networksreportingentitytable"},{"title":"Get Reporting Summary","openapi":"openapi/reporting-aggregated.yaml post /networks/reporting/entity/summary","href":"/api-reference/post-networksreportingentitysummary"},{"title":"Export Aggregated Reporting Data","openapi":"openapi/reporting-exports.yaml post /networks/reporting/entity/table/export","href":"/api-reference/post-networksreportingentitytableexport"}]},{"group":"Clicks","pages":[{"title":"Get a Click by Transaction ID","openapi":"openapi/reporting-clicks.yaml get /networks/reporting/clicks/{transactionId}","href":"/api-reference/get-networksreportingclicks"},{"title":"Get Click Report","openapi":"openapi/reporting-clicks.yaml post /networks/reporting/clicks/stream","href":"/api-reference/post-networksreportingclicksstream"},{"title":"Get Invalid Clicks Report","openapi":"openapi/reporting-impressions.yaml post /networks/reporting/invalidclicks","href":"/api-reference/post-networksreportinginvalidclicks"}]},{"group":"Conversions","pages":[{"title":"Get Conversion Report","openapi":"openapi/reporting-conversions.yaml post /networks/reporting/conversions","href":"/api-reference/post-networksreportingconversions"},{"title":"Get a Conversion by Conversion ID","openapi":"openapi/reporting-conversions.yaml get /networks/reporting/conversions/{conversionId}","href":"/api-reference/get-networksreportingconversions"},{"title":"Export Conversions","openapi":"openapi/reporting-exports.yaml post /networks/reporting/conversions/export","href":"/api-reference/post-networksreportingconversionsexport"},{"title":"Search Conversions by Email","openapi":"openapi/reporting-conversions.yaml post /networks/reporting/conversions/email","href":"/api-reference/post-networksreportingconversionsbyemail"}]},{"group":"Dashboard","pages":[{"title":"Get Dashboard Summary","openapi":"openapi/reporting-dashboard.yaml get /networks/dashboard/summary","href":"/api-reference/get-networksdashboardsummary"}]},{"group":"Events","pages":[{"title":"Search Post-Conversion Events","openapi":"openapi/reporting-aggregated.yaml post /networks/reporting/postconversions","href":"/api-reference/post-networksreportingpostconversions"}]},{"group":"Impressions","pages":[{"title":"Get Impressions Report","openapi":"openapi/reporting-impressions.yaml post /networks/reporting/impressions/stream","href":"/api-reference/post-networksreportingimpressionsstream"}]},{"group":"On-Hold Conversions","pages":[{"title":"Search On-Hold Conversions","openapi":"openapi/reporting-onhold.yaml post /networks/reporting/onhold","href":"/api-reference/post-networksreportingonholdconversions"},{"title":"Get On-Hold Conversion by ID","openapi":"openapi/reporting-onhold.yaml get /networks/reporting/onhold/{onHoldId}","href":"/api-reference/get-networksreportingonhold"},{"title":"Export On-Hold Conversions","openapi":"openapi/reporting-exports.yaml post /networks/reporting/onhold/export","href":"/api-reference/post-networksreportingonholdexport"}]},{"group":"Partner Postback","pages":[{"title":"Get Partner Pixel Log","openapi":"openapi/reporting-postbacks.yaml post /networks/reporting/affiliate/pixels","href":"/api-reference/post-networksreportingpixelslog"},{"title":"Export Partner Pixel Log","openapi":"openapi/reporting-exports.yaml post /networks/reporting/affiliate/pixels/export","href":"/api-reference/post-networksreportingaffiliatepixelsexport"}]},{"group":"Transactions","pages":[{"title":"Get Transaction Overview","openapi":"openapi/reporting-transactions.yaml get /networks/reporting/transactions/{transactionId}","href":"/api-reference/get-networksreportingtransactions"},{"title":"Get Events Per Transaction","openapi":"openapi/reporting-events.yaml get /networks/reporting/events/{transactionId}","href":"/api-reference/get-networksreportingeventspertransaction"},{"title":"Get Transaction Flowchart","openapi":"openapi/reporting-transactions.yaml get /networks/reporting/transactions/{transactionId}/flowchart","href":"/api-reference/get-networksreportingtransactionflowchart"}]}]},{"group":"Sign Up","expanded":false,"pages":[{"title":"Submit Affiliate Signup","openapi":"openapi/signup.yaml post /networks/affiliate/signup","href":"/api-reference/post-networkssignupaffiliate"},{"title":"Submit Advertiser Signup","openapi":"openapi/signup.yaml post /networks/advertiser/signup","href":"/api-reference/post-networkssignupadvertiser"}]},{"group":"Smart Links","expanded":false,"pages":[{"title":"Create Smart Link","openapi":"openapi/smart-links.yaml post /networks/campaigns","href":"/api-reference/post-networkscampaigns"},{"title":"Update Smart Link","openapi":"openapi/smart-links.yaml put /networks/campaigns/{campaignId}","href":"/api-reference/put-networkscampaign"},{"title":"Get Smart Link","openapi":"openapi/smart-links.yaml get /networks/campaigns/{campaignId}","href":"/api-reference/get-networkscampaign"},{"title":"List Smart Links","openapi":"openapi/smart-links.yaml get /networks/campaigns","href":"/api-reference/get-networkscampaigns"}]},{"group":"Tiered Commissions","expanded":false,"pages":[{"title":"Update Tiered Commission","openapi":"openapi/tiered-commissions.yaml put /networks/tieredcommissions/{commissionId}","href":"/api-reference/put-networkstieredcommission"},{"title":"Get Tiered Commission","openapi":"openapi/tiered-commissions.yaml get /networks/tieredcommissions/{commissionId}","href":"/api-reference/get-networkstieredcommission"},{"title":"Find Tiered Commissions (Advanced)","openapi":"openapi/tiered-commissions.yaml post /networks/tieredcommissions/table","href":"/api-reference/post-networkstieredcommissionstable"},{"title":"Create Tiered Commission","openapi":"openapi/tiered-commissions.yaml post /networks/tieredcommissions","href":"/api-reference/post-networkstieredcommissions"}]},{"group":"Tracking Links","expanded":false,"pages":[{"title":"Generate Tracking Link","openapi":"openapi/tracking.yaml post /networks/tracking/offers/clicks","href":"/api-reference/post-networkstrackingoffersclicks"},{"title":"Create Campaign Click Tracking URL","openapi":"openapi/tracking.yaml post /networks/tracking/campaigns/clicks","href":"/api-reference/post-networkstrackingcampaignsclicks"},{"title":"Create Campaign Click QR Code","openapi":"openapi/tracking.yaml post /networks/tracking/campaigns/clicks/qr","href":"/api-reference/post-networkstrackingcampaignsclicksqr"},{"title":"Create Offer Click QR Code","openapi":"openapi/tracking.yaml post /networks/tracking/offers/clicks/qr","href":"/api-reference/post-networkstrackingoffersclicksqr"},{"title":"Generate Offer URL Tracking Link","openapi":"openapi/tracking.yaml get /networks/offers/{offerId}/trackingdomain/{domainId}/url/{affiliateId}/{urlId}","href":"/api-reference/get-networksoffertrackingurl"}]},{"group":"Traffic Controls","expanded":false,"pages":[{"title":"Create Traffic Control","openapi":"openapi/traffic-controls.yaml post /networks/trafficcontrols","href":"/api-reference/post-networkstrafficcontrols"},{"title":"Update Traffic Control","openapi":"openapi/traffic-controls.yaml put /networks/trafficcontrols/{controlId}","href":"/api-reference/put-networkstrafficcontrol"},{"title":"Get Traffic Control","openapi":"openapi/traffic-controls.yaml get /networks/trafficcontrols/{controlId}","href":"/api-reference/get-networkstrafficcontrol"},{"title":"List Traffic Controls","openapi":"openapi/traffic-controls.yaml get /networks/trafficcontrols","href":"/api-reference/get-networkstrafficcontrols"},{"title":"Delete Traffic Control","openapi":"openapi/traffic-controls.yaml delete /networks/trafficcontrols/{controlId}","href":"/api-reference/delete-networkstrafficcontrol"},{"title":"Find Traffic Controls (Advanced)","openapi":"openapi/traffic-controls.yaml post /networks/trafficcontrolstable","href":"/api-reference/post-networkstrafficcontrolstable"}]},{"group":"Traffic Health","expanded":false,"pages":[{"title":"Get Traffic Health Access","openapi":"openapi/traffic-health.yaml get /networks/traffic/access","href":"/api-reference/get-networkstrafficaccess"},{"title":"Get Network Situation Summary","openapi":"openapi/traffic-health.yaml post /networks/traffic/situation","href":"/api-reference/post-networkstrafficsituation"},{"title":"List Domain Situations","openapi":"openapi/traffic-health.yaml post /networks/traffic/situation/domains","href":"/api-reference/post-networkstrafficsituationdomains"},{"title":"Get Domain Situation","openapi":"openapi/traffic-health.yaml post /networks/traffic/domains/{domainUrl}/situation","href":"/api-reference/post-networkstrafficdomainsituation"},{"title":"Get Incident","openapi":"openapi/traffic-health.yaml get /networks/traffic/incidents/{incidentIdentifier}","href":"/api-reference/get-networkstrafficincident"},{"title":"List Tasks","openapi":"openapi/traffic-health.yaml get /networks/traffic/tasks","href":"/api-reference/get-networkstraffictasks"},{"title":"Get Task","openapi":"openapi/traffic-health.yaml get /networks/traffic/tasks/{taskIdentifier}","href":"/api-reference/get-networkstraffictask"},{"title":"Get Domain Blacklist Incident","openapi":"openapi/traffic-health.yaml get /networks/traffic/blacklistincidents/domains/{blacklistIncidentIdentifier}","href":"/api-reference/get-networkstrafficdomainblacklistincident"},{"title":"Get IP Address Blacklist Incident","openapi":"openapi/traffic-health.yaml get /networks/traffic/blacklistincidents/ipaddresses/{blacklistIncidentIdentifier}","href":"/api-reference/get-networkstrafficipblacklistincident"},{"title":"Get Domain Assignment Summary","openapi":"openapi/traffic-health.yaml get /networks/traffic/assignments/{domainUrl}/summary","href":"/api-reference/get-networkstrafficassignmentsummary"},{"title":"Get Domain Usage","openapi":"openapi/traffic-health.yaml post /networks/traffic/usage/domains","href":"/api-reference/post-networkstrafficusagedomains"},{"title":"Get Domain Mismatches","openapi":"openapi/traffic-health.yaml post /networks/traffic/mismatches/{networkTrackingDomainId}","href":"/api-reference/post-networkstrafficmismatches"},{"title":"List ISP Trends","openapi":"openapi/traffic-health.yaml get /networks/traffic/isptrends","href":"/api-reference/get-networkstrafficisptrends"}]},{"group":"Traffic Sources","expanded":false,"pages":[{"title":"List Traffic Sources","openapi":"openapi/traffic-sources.yaml get /networks/trafficsource","href":"/api-reference/get-networkstrafficsources"},{"title":"Get Traffic Source by ID","openapi":"openapi/traffic-sources.yaml get /networks/trafficsource/{trafficSourceId}","href":"/api-reference/get-networkstrafficsource"},{"title":"Create Traffic Source","openapi":"openapi/traffic-sources.yaml post /networks/trafficsource","href":"/api-reference/post-networkstrafficsource"},{"title":"Update Traffic Source","openapi":"openapi/traffic-sources.yaml put /networks/trafficsource","href":"/api-reference/put-networkstrafficsource"},{"title":"Delete Traffic Source","openapi":"openapi/traffic-sources.yaml delete /networks/trafficsource/{trafficSourceId}","href":"/api-reference/delete-networkstrafficsource"}]},{"group":"Uploading Files","expanded":false,"pages":[{"title":"Upload Temp File","openapi":"openapi/file-upload.yaml post /networks/uploads/temp","href":"/api-reference/post-networksupload"}]},{"group":"Webhooks","expanded":false,"pages":[{"title":"Create Webhook","openapi":"openapi/webhooks.yaml post /networks/webhooks","href":"/api-reference/post-networkswebhooks"},{"title":"Update Webhook","openapi":"openapi/webhooks.yaml put /networks/webhooks/{webhookId}","href":"/api-reference/put-networkswebhook"},{"title":"Get Webhook Config","openapi":"openapi/webhooks.yaml get /networks/webhooks/{webhookId}","href":"/api-reference/get-networkswebhook"},{"title":"Get Webhook Delivery Logs","openapi":"openapi/webhooks.yaml get /networks/webhooks/{webhookId}/logs","href":"/api-reference/get-networkswebhooklogs"},{"title":"Delete Webhook","openapi":"openapi/webhooks.yaml delete /networks/webhooks/{webhookId}","href":"/api-reference/delete-networkswebhook"}]}]}]},{"tab":"Affiliate API","pages":[{"title":"Affiliate API","href":"/api-reference/affiliate-overview"}]},{"tab":"Advertiser API","pages":[{"title":"Advertiser API","href":"/api-reference/advertiser-overview"}]},{"tab":"Marketplace API","pages":[{"title":"Marketplace API","href":"/api-reference/marketplace-overview"}]},{"tab":"Network MCP","pages":[{"title":"Network MCP","href":"/ai-automation/mcp/overview"}]},{"tab":"Affiliate MCP (Beta)","pages":[{"title":"Affiliate MCP (Beta)","href":"/ai-automation/affiliate-mcp/overview"}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/webhooks/overview"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk/overview"}]}]},"title":"List Rules - Everflow API","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}