https://refersion.dev/assets/js/63b9dc4e.0ad344ef.js

1"use strict";(globalThis.webpackChunkdocs_site=globalThis.webpackChunkdocs_site||[]).push([[7091],{50081(e,n,i){i.r(n),i.d(n,{assets:()=>v,contentTitle:()=>b,default:()=>q,frontMatter:()=>h,metadata:()=>t,toc:()=>x});const t=JSON.parse('{"id":"affiliate-count","title":"Get Affiliate Counts","description":"Returns the count of affiliates grouped by status (pending, approved, denied)","source":"@site/api-docs/affiliate-count.api.mdx","sourceDirName":".","slug":"/affiliate-count","permalink":"/docs/api-reference/affiliate-count","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"affiliate-count","title":"Get Affiliate Counts","description":"Returns the count of affiliates grouped by status (pending, approved, denied)","sidebar_label":"Get Affiliate Counts","hide_title":true,"hide_table_of_contents":true,"api":"eJztWd1uG7cSfpUBb5IAa0mxm6JQrxzHJ3DRkxqO21zYQj3ijrRsdsk1yZWtGgL6EH3C8yQHw11Jqx/bK3lzgAP0yvKS883/kJx5ECYni14ZfRaLvsDRSKUKPXWkKbQXkYjJSaty3iH64oJ8YbUDnxCEHWBGsCByMLamyCmG4RScR184eJ2TjpUeR4B5bs2E4ghi0oriN9d6ZGyAwsInpL2S6CmGjKxMUPsOXCZUbT4JzJSWaRGTg/fHnz6dfqhz/s9ff1/rIWpNcf0z2kpQiuFO+UTpwLAEhWEhv5LvwJeENEhM02qXKfy1HqnUk4UcLWbkyboILLki9RUqyoRiYBXeQqZ04alzra/15yLPjfWljRxmBBtAgA4+nl5CdyloJUO5tWTgijxPFcXRtQ7mZn6gHAynOTrHauq41M2BpVFK0geeJQbFlbTgWMNzsiNjM9SSDlxOUo2UnKvo4DXTHX13sBARMvRW3QNKa1ypysKPR72DGKdRYO+Nx7Qyo4uudZ4WDhJ05+XmE6MnZJ0y2oXtKTq//PYBp+54bN6ARmvNHRidTstwqCIlOP3Ha53P0TgGGKceE2wqbTw7naQvY88nxs0N4ToiEh7HTvSvRM3iYhCJpUtE/+pBaMxI9IUjtDIRkVAc8rcF2amIhJMJZSj6D8JP87DNW6XHIhIZ3v9MeuwT0T989242ixZIWy3xLPDQmJRQizrSVss9i6S0pzFZllFplRWZ6PfqqJVhL2hCuqB/K/0soi6yYXNAvG8J8MRkmXKsentC1jBblHPh5iaCNvRPHbWBqA1Rz3FqCt9IzmbKzwFbs+avWt0W9IuNybZpzhXYFuzJuXnU45xsL5E2MV9u1SVmq+m0FbZdaVtNqu3ArcZBe6m1idmqZVMlv7Zt1BKzVXu2XQgeQW5B5nAhaq8MrMC93PMBrtXkX0dsTcZWU34Dsy1Pt5foK3BtWbG19K7DtWW7tpN6E7QFSc1oRPYsdleDZ6HQWuQF5SlzT7N4O6vzsM3LRfXm2EbdQNkt1HKZFD8viuKekmzH2kWuQSQsudxoR8GCh70e/1ntQRzPn3DLx6+3iiYUgyukJOdGRZoyI2m0J+0ZAvktLUOjo/uHY5yHTTnM8A+S3PTILbdFvCqliNE32FV/pG71/qoWn0L+rrVPuPcwf2hXDRR+vdI9ZnnKbK7eDWaRWHkfv4jXHGnRrfnwfv7z1fHJ5dlvp68gw9yBN3B8frZYm9O9erMm39tDFrD2Pn+ReFWbprIEnH2b9s+qBkeD2YzD8LZQlmJuGqx4dt36q8oOIuGVT6kepmHlgpwprCSxDh6CazDjgiC+673dEu7L3pgyGha0u4f3omFR0/ZBTDAtiHeRtcY+wXAWCVdkGdqp6OsiTdfcWH6ie09WY/pbicofZ3PtDg83tTvTE0xVDKE21FpkL8nep9XjnuKy4i5ZctsKhkSsMRc0bm7BtqddZ39LRI/Is+21B1nhPAwJxpaQ5fMJajAW6LbA9H8o3JYL2UI2hNJ9VWp/K+5L/ZacPaSEzkPvBUwH60U8I+dwTNuSZjVuT1lEB2ZCdqLoLsgQxHbbInItoyEmj4qbzbUFrn+EMoGRojRmb3sYlbuCjUP0c63COFb8G9PzFdmfuYYsDtn1CjTXeaFAla/vth2+Z7q0IjiyE7JQuuqbJeuxLjmAkbKw3NS+S1RK8yOfj0lcuw60GA2VFJuxII12fl/x1sxfMgk2n0UiI58YnsSMKVwxkLvK9bZ1dz6YKR1Q2q2wKXebvc9dv9vFXHUsjcp07UiTdSeHvcPvD3o/bIRihkoLVtyRLKzy0wDHQKJ/NagvfGYPlmYplxdWCf9Wt7rQvia04ZQvf/yLxw5srJ++XAbllR6ZQF4dlBdzUfmGISJR1RnRF0edXqe3ITNXhSXNxennSybswAXdFuS8A4nWTgHhfeAP3nwlDdXJf8Onm7HqzxCfN5AQxmT5+gCkfEIWcDF/gp++XHLBRQ2/MBncyFSR9r9LSzGfkJi6G8Bw5ay4mKFHxXeQkTVZybBreLrVDes3QDrOjeK5mV5MvkIuKUkd+EwUvl6tncG+8MYqTAevu7GRjj18EDxMWlIXVza/CSOpxNzxETEmzeM9gprIEdA96zcOvLKwHfWKHuVwhwdiQRw2L6dVbpzPMCR0deX/SB6W9/GTMsLXHPawLA7/zA//mR/+f84Py1Ln6d538zQUzaisug9Vjb4StdEinxDVcyAxfFJciYeHITr61aazGX8u38JcbGPlcJjyWTDC1FEkvtK0PoSszkQh+Ir0yObH5oxNaB+bLDah3TY/3IMutAh2oFvvYO5HujvXtZ7knrS78l3pMe5Btyu/zb7cvsSNOT8yQduPdA+u+wTU42OvXan3CKsnZli7ke8cXI8MpHYUutaY3otyD577hfVTk6Im9JvzoJ2pduO1TyhvHeLsQLhHAG+fyDSm3DlsN8crzaXcMVg3ZiWNifYL0UfmHk1IV6YbTQjsrpFsdw3iJwYS+5OvcR/wP1YxfXjmRqJ8Bob7WIlzLCXlvka10dVglMVr/eMpv23/C75VYbM=","sidebar_class_name":"get api-method","info_path":"docs/api-reference//refersion-api","custom_edit_url":null},"sidebar":"apiSidebar","previous":{"title":"Delete Promotion Method","permalink":"/docs/api-reference/promotion-method-delete"},"next":{"title":"List Affiliates","permalink":"/docs/api-reference/affiliate-index"}}');var a=i(74848),s=i(28453),r=i(57742),m=i.n(r),u=i(78178),o=i.n(u),l=i(19624),d=i.n(l),p=i(96226),c=i.n(p),y=(i(77675),i(74070),i(44608)),f=i(21312);const h={id:"affiliate-count",title:"Get Affiliate Counts",description:"Returns the count of affiliates grouped by status (pending, approved, denied)",sidebar_label:"Get Affiliate Counts",hide_title:!0,hide_table_of_contents:!0,api:"eJztWd1uG7cSfpUBb5IAa0mxm6JQrxzHJ3DRkxqO21zYQj3ijrRsdsk1yZWtGgL6EH3C8yQHw11Jqx/bK3lzgAP0yvKS883/kJx5ECYni14ZfRaLvsDRSKUKPXWkKbQXkYjJSaty3iH64oJ8YbUDnxCEHWBGsCByMLamyCmG4RScR184eJ2TjpUeR4B5bs2E4ghi0oriN9d6ZGyAwsInpL2S6CmGjKxMUPsOXCZUbT4JzJSWaRGTg/fHnz6dfqhz/s9ff1/rIWpNcf0z2kpQiuFO+UTpwLA

1EhWEhv5LvwJeENEhM02qXKfy1HqnUk4UcLWbkyboILLki9RUqyoRiYBXeQqZ04alzra/15yLPjfWljRxmBBtAgA4+nl5CdyloJUO5tWTgijxPFcXRtQ7mZn6gHAynOTrHauq41M2BpVFK0geeJQbFlbTgWMNzsiNjM9SSDlxOUo2UnKvo4DXTHX13sBARMvRW3QNKa1ypysKPR72DGKdRYO+Nx7Qyo4uudZ4WDhJ05+XmE6MnZJ0y2oXtKTq//PYBp+54bN6ARmvNHRidTstwqCIlOP3Ha53P0TgGGKceE2wqbTw7naQvY88nxs0N4ToiEh7HTvSvRM3iYhCJpUtE/+pBaMxI9IUjtDIRkVAc8rcF2amIhJMJZSj6D8JP87DNW6XHIhIZ3v9MeuwT0T989242ixZIWy3xLPDQmJRQizrSVss9i6S0pzFZllFplRWZ6PfqqJVhL2hCuqB/K/0soi6yYXNAvG8J8MRkmXKsentC1jBblHPh5iaCNvRPHbWBqA1Rz3FqCt9IzmbKzwFbs+avWt0W9IuNybZpzhXYFuzJuXnU45xsL5E2MV9u1SVmq+m0FbZdaVtNqu3ArcZBe6m1idmqZVMlv7Zt1BKzVXu2XQgeQW5B5nAhaq8MrMC93PMBrtXkX0dsTcZWU34Dsy1Pt5foK3BtWbG19K7DtWW7tpN6E7QFSc1oRPYsdleDZ6HQWuQF5SlzT7N4O6vzsM3LRfXm2EbdQNkt1HKZFD8viuKekmzH2kWuQSQsudxoR8GCh70e/1ntQRzPn3DLx6+3iiYUgyukJOdGRZoyI2m0J+0ZAvktLUOjo/uHY5yHTTnM8A+S3PTILbdFvCqliNE32FV/pG71/qoWn0L+rrVPuPcwf2hXDRR+vdI9ZnnKbK7eDWaRWHkfv4jXHGnRrfnwfv7z1fHJ5dlvp68gw9yBN3B8frZYm9O9erMm39tDFrD2Pn+ReFWbprIEnH2b9s+qBkeD2YzD8LZQlmJuGqx4dt36q8oOIuGVT6kepmHlgpwprCSxDh6CazDjgiC+673dEu7L3pgyGha0u4f3omFR0/ZBTDAtiHeRtcY+wXAWCVdkGdqp6OsiTdfcWH6ie09WY/pbicofZ3PtDg83tTvTE0xVDKE21FpkL8nep9XjnuKy4i5ZctsKhkSsMRc0bm7BtqddZ39LRI/Is+21B1nhPAwJxpaQ5fMJajAW6LbA9H8o3JYL2UI2hNJ9VWp/K+5L/ZacPaSEzkPvBUwH60U8I+dwTNuSZjVuT1lEB2ZCdqLoLsgQxHbbInItoyEmj4qbzbUFrn+EMoGRojRmb3sYlbuCjUP0c63COFb8G9PzFdmfuYYsDtn1CjTXeaFAla/vth2+Z7q0IjiyE7JQuuqbJeuxLjmAkbKw3NS+S1RK8yOfj0lcuw60GA2VFJuxII12fl/x1sxfMgk2n0UiI58YnsSMKVwxkLvK9bZ1dz6YKR1Q2q2wKXebvc9dv9vFXHUsjcp07UiTdSeHvcPvD3o/bIRihkoLVtyRLKzy0wDHQKJ/NagvfGYPlmYplxdWCf9Wt7rQvia04ZQvf/yLxw5srJ++XAbllR6ZQF4dlBdzUfmGISJR1RnRF0edXqe3ITNXhSXNxennSybswAXdFuS8A4nWTgHhfeAP3nwlDdXJf8Onm7HqzxCfN5AQxmT5+gCkfEIWcDF/gp++XHLBRQ2/MBncyFSR9r9LSzGfkJi6G8Bw5ay4mKFHxXeQkTVZybBreLrVDes3QDrOjeK5mV5MvkIuKUkd+EwUvl6tncG+8MYqTAevu7GRjj18EDxMWlIXVza/CSOpxNzxETEmzeM9gprIEdA96zcOvLKwHfWKHuVwhwdiQRw2L6dVbpzPMCR0deX/SB6W9/GTMsLXHPawLA7/zA//mR/+f84Py1Ln6d538zQUzaisug9Vjb4StdEinxDVcyAxfFJciYeHITr61aazGX8u38JcbGPlcJjyWTDC1FEkvtK0PoSszkQh+Ir0yObH5oxNaB+bLDah3TY/3IMutAh2oFvvYO5HujvXtZ7knrS78l3pMe5Btyu/zb7cvsSNOT8yQduPdA+u+wTU42OvXan3CKsnZli7ke8cXI8MpHYUutaY3otyD577hfVTk6Im9JvzoJ2pduO1TyhvHeLsQLhHAG+fyDSm3DlsN8crzaXcMVg3ZiWNifYL0UfmHk1IV6YbTQjsrpFsdw3iJwYS+5OvcR/wP1YxfXjmRqJ8Bob7WIlzLCXlvka10dVglMVr/eMpv23/C75VYbM=",sidebar_class_name:"get api-method",info_path:"docs/api-reference//refersion-api",custom_edit_url:null},b=void 0,v={},x=[];function R(e){const n={p:"p",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(y.default,{as:"h1",className:"openapi__heading",children:"Get Affiliate Counts"}),"\n",(0,a.jsx)(m(),{method:"get",path:"/affiliates/count",context:"endpoint"}),"\n",(0,a.jsx)(n.p,{children:"Returns the count of affiliates grouped by status (pending, approved, denied)\nfor the authenticated merchant. The deniedCount includes BANNED affiliates \u2014\nbanned affiliates are counted within the denied bucket. When called without\nfilter parameters, results are cached for 1 minute."}),"\n",(0,a.jsx)(n.p,{children:"Supports the same filter parameters as GET /affiliates. When filters are supplied,\nthe cache is bypassed and counts reflect the filtered result set. Performance-specific\nfilters (the 34-parameter matrix across the pending, 30-day, and total buckets,\nplus hasPendingConversions and lastConversionDaysAgo) narrow only the approvedCount;\npendingCount and deniedCount are not affected by those filters."}),"\n",(0,a.jsx)(y.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:(0,a.jsx)(f.default,{id:"theme.openapi.request.title",children:"Request"})}),"\n",(0,a.jsx)(o(),{parameters:[{name:"search",in:"query",schema:{type:"string",maxLength:255}},{name:"hasPendingConversions",in:"query",schema:{type:"boolean"}},{name:"lastConversionDaysAgo",in:"query",schema:{type:"integer",minimum:0}},{name:"pendingRevenueMin",in:"query",schema:{type:"number",minimum:0}},{name:"pendingRevenueMax",in:"query",schema:{type:"number",minimum:0}},{name:"pendingCommissionMin",in:"query",schema:{type:"number",minimum:0}},{name:"pendingCommissionMax",in:"query",schema:{type:"number",minimum:0}},{name:"pendingConversionsMin",in:"query",schema:{type:"integer",minimum:0}},{name:"pendingConversionsMax",in:"query",schema:{type:"integer",minimum:0}},{name:"pendingPayoutsMin",in:"query",schema:{type:"number",minimum:0}},{name:"pendingPayoutsMax",in:"query",schema:{type:"number",minimum:0}},{name:"pendingUniqueOrdersMin",in:"query",schema:{type:"integer",minimum:0}},{name:"pendingUniqueOrdersMax",in:"query",schema:{type:"integer",minimum:0}},{name:"last30DaysRevenueMin",in:"query",schema:{type:"number",minimum:0}},{name:"last30DaysRevenueMax",in:"query",schema:{type:"number",minimum:0}},{name:"last30DaysCommissionMin",in:"query",schema:{type:"number",minimum:0}},{name:"last30DaysCommissionMax",in:"query",schema:{type:"number",minimum:0}},{name:"last30DaysConversionsMin",in:"query",schema:{type:"integer",minimum:0}},{name:"last30DaysConversionsMax",in:"query",schema:{type:"integer",minimum:0}},{name:"last30DaysPayoutsMin",in:"query",schema:{type:"number",minimum:0}},{name:"last30DaysPayoutsMax",in:"query",schema:{type:"number",minimum:0}},{name:"last30DaysClicksMin",in:"query",schema:{type:"integer",minimum:0}},{name:"last30DaysClicksMax",in:"query",schema:{type:"integer",minimum:0}},{name:"last30DaysUniqueOrdersMin",in:"query",schema:{type:"integer",minimum:0}},{name:"last30DaysUniqueOrdersMax",in:"query",schema:{type:"integer",minimum:0}},{name:"totalRevenueMin",in:"query",schema:{type:"number",minimum:0}},{name:"totalRevenueMax",in:"query",schema:{type:"number",minimum:0}},{name:"totalCommissionMin",in:"query",schema:{type:"number",minimum:0}},{name:"totalCommissionMax",in:"query",schema:{type:"number",minimum:0}},{name:"totalConversionsMin",in:"query",schema:{type:"integer",minimum:0}},{name:"totalConversionsMax",in:"query",schema:{type:"integer",minimum:0}},{name:"totalPayoutsMin",in:"query",schema:{type:"number",minimum:0}},{name:"totalPayoutsMax",in:"query",schema:{type:"number",minimum:0}},{name:"totalClicksMin",in:"query",schema:{type:"integer",minimum:0}},{name:"totalClicksMax",in:"query",schema:{type:"integer",minimum:0}},{name:"totalUniqueOrdersMin",in:"query",schema:{type:"integer",minimum:0}},{name:"totalUniqueOrdersMax",in:"query",schema:{type:"integer",minimum:0}},{name:"offerIds[]",in:"query",schema:{type:"array",items:{type:"integer",minimum:1}}},{name:"revenueMin",in:"query",schema:{type:"string"}},{name:"revenueMax",in:"query",schema:{type:"string"}},{name:"conversionsLast30DaysMin",in:"query",schema:{type:"string"}},{name:"conversionsLast30DaysMax",in:"query",schema:{type:"string"}}]}),"\n",(0,a.jsx)(d(),{title:"Body"}),"\n",(0,a.jsx)(c(),{responses:{200:{description:"Affiliate counts retrieved successfully",content:{"application/json":{schema:{type:"object",properties:{data:{type:"object",properties:{pendingCount:{type:"integer",description:"Number of affiliates with pending status.",examples:[5]},approvedCount:{type:"integer",description:"Number of affiliates with approved status (DB status 'ACTIVE' maps to API status 'approved').",examples:[12]},deniedCount:{type:"integer",description:"Number of affiliates with denied 

1status. Includes BANNED affiliates \u2014\nbanned affiliates are counted within the denied bucket.",examples:[3]}},required:["pendingCount","approvedCount","deniedCount"],title:"AffiliateCountResource"}},required:["data"]}}}},401:{description:"Authentication required",content:{"application/json":{schema:{type:"string",examples:[{value:{error:"Authentication required"},summary:null,description:null,externalValue:null}]}}}},422:{description:"Invalid query parameters",content:{"application/json":{schema:{type:"object",examples:[{value:{error:"The revenueMin parameter has been renamed to last30DaysRevenueMin."},summary:null,description:null,externalValue:null},{value:{error:"The last30DaysRevenueMax must be greater than or equal to last30DaysRevenueMin."},summary:null,description:null,externalValue:null},{value:{error:"The totalConversionsMin must be a valid integer."},summary:null,description:null,externalValue:null},{value:{error:"The totalRevenueMin must be at least 0."},summary:null,description:null,externalValue:null}],properties:{message:{type:"string",description:"Errors overview."},errors:{type:"object",description:"A detailed description of each field that failed validation.",additionalProperties:{type:"array",items:{type:"string"}}}},required:["message","errors"]}}}},500:{description:"Internal server error",content:{"application/json":{schema:{type:"object",examples:[{value:{error:"An error occurred while retrieving affiliate counts"},summary:null,description:null,externalValue:null}],properties:{error:{type:"string",const:"An error occurred while retrieving affiliate counts"}},required:["error"]}}}}}})]})}function q(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(R,{...e})}):R(e)}}}]);