Returns the project affiliates with their totals for a period, oldest joiner first. Affiliates with no activity in the period are omitted. Note 1: this endpoint is only accessible with a secret API key. Note 2: a period may span at most 90 days; request a longer window a period at a time. Note 3: up to 100 affiliates are returned per request; page through the rest with offset.
GET
/
affiliates
/
analytics
Get Affiliate Analytics
curl --request GET \ --url https://api.winwinkit.com/affiliates/analytics \ --header 'x-api-key: <x-api-key>'
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"WinWinKit","colors":{"primary":"#111113","light":"#D4FF70","dark":"#111113"},"logo":{"light":"https://mintcdn.com/winwinkit/oupABwSJKqsW2S9I/logo.svg?fit=max\u0026auto=format\u0026n=oupABwSJKqsW2S9I\u0026q=85\u0026s=b86c7815e871849dfcc12ff274566f7f","dark":"https://mintcdn.com/winwinkit/oupABwSJKqsW2S9I/logo.svg?fit=max\u0026auto=format\u0026n=oupABwSJKqsW2S9I\u0026q=85\u0026s=b86c7815e871849dfcc12ff274566f7f","href":"https://winwinkit.com"},"favicon":"https://mintcdn.com/winwinkit/0_2EgLS_ZGMDKoou/favicon.ico?fit=max\u0026auto=format\u0026n=0_2EgLS_ZGMDKoou\u0026q=85\u0026s=d949925d660c95a4397bb4e2171d1625","api":{"openapi":"https://api.winwinkit.com/openapi-yaml","playground":{"display":"interactive"},"examples":{"languages":["curl","javascript"]}},"appearance":{"default":"dark","strict":true},"background":{"color":{"light":"#FCFCFD","dark":"#111113"}},"navbar":{"links":[{"href":"https://github.com/winwinkit","label":"GitHub"},{"href":"https://winwinkit.com","label":"Get Started"}]},"footer":{"socials":{"website":"https://winwinkit.com","reddit":"https://reddit.com/r/winwinkit","linkedin":"https://linkedin.com/company/winwinkit","bluesky":"https://bsky.app/profile/winwinkit.bsky.social","x-twitter":"https://x.com/winwin_kit","github":"https://github.com/winwinkit"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"winwinkit","hasAudioNarration":false,"actualSubdomain":"winwinkit","customDomains":["docs.winwinkit.com"],"gitSource":{"type":"github","owner":"winwinkit","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad9dfe0db34909eda5941ca","collectionId":"21b61ff3-14ff-4d1a-8601-ef9792c0578e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad9dfe0db34909eda5941ca"},"entitlements":{},"buildId":"6ad9dfe0db34909eda5941ca","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"Platform API","count":7},{"language":"default","tag":"Client API","count":7},{"language":"default","tag":"Affiliate Payouts","count":3},{"language":"default","tag":"Users","count":3},{"language":"default","tag":"Affiliates","count":2},{"language":"default","tag":"User Rewards","count":2},{"language":"default","tag":"Transactions","count":2},{"language":"default","tag":"Claim Code","count":1},{"language":"default","tag":"Codes","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/affiliates/analytics","slug":"/api-reference/affiliates/analytics","pageMetadata":{"openapi":"get /affiliates/analytics","title":"Get Affiliate Analytics","description":"Returns the project affiliates with their totals for a period, oldest joiner first. Affiliates with no activity in the period are omitted. Note 1: this endpoint is only accessible with a secret API key. Note 2: a period may span at most 90 days; request a longer window a period at a time. Note 3: up to 100 affiliates are returned per request; page through the rest with `offset`.","href":"/api-reference/affiliates/analytics"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns the project affiliates with their totals for a period, oldest joiner first. Affiliates with no activity in the period are omitted. Note 1: this endpoint is only accessible with a secret API key. Note 2: a period may span at most 90 days; request a longer window a period at a time. Note 3: up to 100 affiliates are returned per request; page through the rest with \", _jsx(_components.code, {\n children: \"offset\"\n }), \".\"]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}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":{"openapi":"get /affiliates/analytics","title":"Get Affiliate Analytics","description":"Returns the project affiliates with their totals for a period, oldest joiner first. Affiliates with no activity in the period are omitted. Note 1: this endpoint is only accessible with a secret API key. Note 2: a period may span at most 90 days; request a longer window a period at a time. Note 3: up to 100 affiliates are returned per request; page through the rest with `offset`.","href":"/api-reference/affiliates/analytics"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Returns the project affiliates with their totals for a period, oldest joiner first. Affiliates with no activity in the period are omitted. Note 1: this endpoint is only accessible with a secret API key. Note 2: a period may span at most 90 days; request a longer window a period at a time. Note 3: up to 100 affiliates are returned per request; page through the rest with `offset`.","operationId":"getAffiliateAnalytics","parameters":["55ac0840-5cb6-4634-8f1f-a7902deb594a","bf89aa6d-d14c-4a6f-8190-7bbc42a782b3","320e4b4f-fe80-4d4a-af5d-cf6810a6a490","3c38d87d-93f1-4655-ad2f-a46d77ec9792","f4714aa5-083c-4f1f-ac06-1c6665d6aea9"],"responses":{"200":"2fdc34d1-2b39-4a94-b6e4-9b954214080a","401":"11c436b2-a8af-40bf-8f52-11ebfc250b9c","422":"cf9ae669-3850-4280-b33a-e083a8b7c67c","429":"2f31d2a6-0e3c-41a6-b2b7-dbdb66c82e47"},"summary":"Get Affiliate Analytics","tags":["Affiliates"],"method":"get","type":"path","servers":["5c2ba6ec-309c-4552-abfa-9038fddeaa39"],"security":[],"path":"/affiliates/analytics","baseUrlOptions":["https://api.winwinkit.com"],"title":"Get Affiliate Analytics","codeSamples":[],"requestExampleLanguages":["bash","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"55ac0840-5cb6-4634-8f1f-a7902deb594a":{"name":"limit","required":false,"in":"query","description":"How many affiliates to return, from 10 to 100.","schema":{"minimum":10,"maximum":100,"default":100,"example":100,"type":"number","isRequired":false,"description":"How many affiliates to return, from 10 to 100.","uniqueKey":"","typeLabel":"number"}},"bf89aa6d-d14c-4a6f-8190-7bbc42a782b3":{"name":"offset","required":false,"in":"query","description":"How many affiliates to skip before the page.","schema":{"minimum":0,"default":0,"example":0,"type":"number","isRequired":false,"description":"How many affiliates to skip before the page.","uniqueKey":"","typeLabel":"number"}},"320e4b4f-fe80-4d4a-af5d-cf6810a6a490":{"name":"from","required":true,"in":"query","description":"The first day of the period, inclusive, as YYYY-MM-DD (UTC).","schema":{"format":"date","example":"2026-01-01","type":"string","isRequired":true,"description":"The first day of the period, inclusive, as YYYY-MM-DD (UTC).","uniqueKey":"","typeLabel":"string\u003cdate>"}},"3c38d87d-93f1-4655-ad2f-a46d77ec9792":{"name":"to","required":true,"in":"query","description":"The last day of the period, inclusive, as YYYY-MM-DD (UTC). Must not be before `from`, and the period must be at most 90 days long.","schema":{"format":"date","example":"2026-03-31","type":"string","isRequired":true,"description":"The last day of the period, inclusive, as YYYY-MM-DD (UTC). Must not be before `from`, and the period must be at most 90 days long.","uniqueKey":"","typeLabel":"string\u003cdate>"}},"f4714aa5-083c-4f1f-ac06-1c6665d6aea9":{"name":"x-api-key","in":"header","description":"The secret API key.","required":true,"schema":{"type":"string","isRequired":true,"description":"The secret API key.","uniqueKey":"","typeLabel":"string"}}},"responses":{"2fdc34d1-2b39-4a94-b6e4-9b954214080a":{"description":"The page of affiliates and their totals for the period.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"from":{"type":"string","example":"2026-01-01","description":"The first day of the period, inclusive","isRequired":true,"uniqueKey":"data.from","typeLabel":"string"},"to":{"type":"string","example":"2026-03-31","description":"The last day of the period, inclusive","isRequired":true,"uniqueKey":"data.to","typeLabel":"string"},"totals":{"type":"object","description":"The totals across every affiliate in the period, not just this page","required":["claims","conversions","revenue","earnings"],"properties":{"claims":{"type":"number","example":120,"description":"The number of times the affiliate's codes were claimed","isRequired":true,"uniqueKey":"data.totals.claims","typeLabel":"number"},"conversions":{"type":"number","example":34,"description":"The number of claims that converted into a purchase","isRequired":true,"uniqueKey":"data.totals.conversions","typeLabel":"number"},"revenue":{"type":"number","example":249900,"description":"The revenue attributed to the affiliate, in USD cents","isRequired":true,"uniqueKey":"data.totals.revenue","typeLabel":"number"},"earnings":{"type":"number","example":49980,"description":"The commission owed to the affiliate on that revenue, in USD cents","isRequired":true,"uniqueKey":"data.totals.earnings","typeLabel":"number"}},"isRequired":true,"uniqueKey":"data.totals","typeLabel":"object"},"affiliates":{"description":"The page of affiliates, oldest joiner first. Affiliates with no activity in the period are omitted.","type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"2772aded-9009-474c-a368-c887dda45b01","description":"The affiliate id","isRequired":true,"uniqueKey":"data.affiliates.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","example":"Jane Doe","description":"The affiliate name","isRequired":true,"uniqueKey":"data.affiliates.items.[INDEX].name","typeLabel":"string"},"accepted_at":{"format":"date-time","type":"string","example":"2026-01-01T00:00:00.000Z","description":"When the affiliate joined the project","isRequired":true,"uniqueKey":"data.affiliates.items.[INDEX].accepted_at","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["pending","withdrawn","approved","rejected","archived","deactivated","banned"],"example":"approved","description":"The affiliate current standing with the project. Not always `approved`: an affiliate is reported for what they did in the period, so one since banned or deactivated still appears alongside the metrics they earned.","isRequired":true,"uniqueKey":"data.affiliates.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"totals":{"type":"object","description":"The affiliate's totals over the period","required":["claims","conversions","revenue","earnings"],"properties":{"claims":{"type":"number","example":120,"description":"The number of times the affiliate's codes were claimed","isRequired":true,"uniqueKey":"data.affiliates.items.[INDEX].totals.claims","typeLabel":"number"},"conversions":{"type":"number","example":34,"description":"The number of claims that converted into a purchase","isRequired":true,"uniqueKey":"data.affiliates.items.[INDEX].totals.conversions","typeLabel":"number"},"revenue":{"type":"number","example":249900,"description":"The revenue attributed to the affiliate, in USD cents","isRequired":true,"uniqueKey":"data.affiliates.items.[INDEX].totals.revenue","typeLabel":"number"},"earnings":{"type":"number","example":49980,"description":"The commission owed to the affiliate on that revenue, in USD cents","isRequired":true,"uniqueKey":"data.affiliates.items.[INDEX].totals.earnings","typeLabel":"number"}},"isRequired":true,"uniqueKey":"data.affiliates.items.[INDEX].totals","typeLabel":"object"}},"required":["id","name","accepted_at","status","totals"],"uniqueKey":"data.affiliates.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.affiliates","typeLabel":"object[]"},"pagination":{"type":"object","description":"Where this page sits within the affiliates that matched","required":["limit","offset","total","has_more"],"properties":{"limit":{"type":"number","example":100,"description":"How many results were requested","isRequired":true,"uniqueKey":"data.pagination.limit","typeLabel":"number"},"offset":{"type":"number","example":0,"description":"How many results were skipped before this page","isRequired":true,"uniqueKey":"data.pagination.offset","typeLabel":"number"},"total":{"type":"number","example":512,"description":"How many results matched in total, across every page","isRequired":true,"uniqueKey":"data.pagination.total","typeLabel":"number"},"has_more":{"type":"boolean","example":true,"description":"Whether another page follows this one","isRequired":true,"uniqueKey":"data.pagination.has_more","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"data.pagination","typeLabel":"object"}},"required":["from","to","totals","affiliates","pagination"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"from":"2026-01-01","to":"2026-03-31","totals":{"claims":120,"conversions":34,"revenue":249900,"earnings":49980},"affiliates":[{"id":"2772aded-9009-474c-a368-c887dda45b01","name":"Jane Doe","accepted_at":"2026-01-01T00:00:00.000Z","status":"approved","totals":{"claims":120,"conversions":34,"revenue":249900,"earnings":49980}}],"pagination":{"limit":100,"offset":0,"total":512,"has_more":true}}}}},"exampleType":"generated"}},"exampleType":"generated"},"11c436b2-a8af-40bf-8f52-11ebfc250b9c":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"integer"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"source":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].source.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"string | null"}},"description":"Error Object","required":["code","status","message","source"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"description":"Errors Response","required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"\u003cstring>","status":123,"message":"\u003cstring>","source":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"cf9ae669-3850-4280-b33a-e083a8b7c67c":{"description":"The request is invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"integer"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"source":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].source.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"string | null"}},"description":"Error Object","required":["code","status","message","source"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"description":"Errors Response","required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"\u003cstring>","status":123,"message":"\u003cstring>","source":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"2f31d2a6-0e3c-41a6-b2b7-dbdb66c82e47":{"description":"The rate limit for this endpoint has been exceeded.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"integer"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"source":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].source.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].source","typeLabel":"string | null"}},"description":"Error Object","required":["code","status","message","source"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"description":"Errors Response","required":["errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"\u003cstring>","status":123,"message":"\u003cstring>","source":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"5c2ba6ec-309c-4552-abfa-9038fddeaa39":{"url":"https://api.winwinkit.com","description":"Production"}}},"originalFileLocation":"https://api.winwinkit.com/openapi-yaml"},"subdomain":"winwinkit","siteName":"WinWinKit","title":"Get Affiliate Analytics - WinWinKit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-21T09:22:12.203Z","originalFileLocation":"api-reference/affiliates/analytics.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";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=\"dark\"}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=\"Returns the project affiliates with their totals for a period, oldest joiner first. Affiliates with no activity in the period are omitted. Note 1: this endpoint is only accessible with a secret API key. Note 2: a period may span at most 90 days; request a longer window a period at a time. Note 3: up to 100 affiliates are returned per request; page through the rest with offset.\">\u003cmeta data-mint-head name=\"application-name\" content=\"WinWinKit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/winwinkit/KktkmV8E25Jn2EDG/_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/winwinkit/KktkmV8E25Jn2EDG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/winwinkit/KktkmV8E25Jn2EDG/_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/winwinkit/KktkmV8E25Jn2EDG/_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/winwinkit/KktkmV8E25Jn2EDG/_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/winwinkit/KktkmV8E25Jn2EDG/_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/winwinkit/KktkmV8E25Jn2EDG/_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/winwinkit/KktkmV8E25Jn2EDG/_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/winwinkit/KktkmV8E25Jn2EDG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Affiliate Analytics - WinWinKit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the project affiliates with their totals for a period, oldest joiner first. Affiliates with no activity in the period are omitted. Note 1: this endpoint is only accessible with a secret API key. Note 2: a period may span at most 90 days; request a longer window a period at a time. Note 3: up to 100 affiliates are returned per request; page through the rest with offset.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"WinWinKit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.winwinkit.com/api-reference/affiliates/analytics\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://winwinkit.mintlify.app/_mintlify/api/og/v2?division=Affiliates\u0026amp;title=Get+Affiliate+Analytics\u0026amp;description=Returns+the+project+affiliates+with+their+totals+for+a+period%2C+oldest+joiner+first.+Affiliates+with+no+activity+in+the+period+are+omitted.+Note+1%3A+this+endpoint\u0026amp;theme=2c0768838a8a88e320968c6a\u0026amp;signature=e785f3d2e51d1895946198178acf68764904c2ab924c3716d7898ddecc565c17\">\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=\"Get Affiliate Analytics - WinWinKit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the project affiliates with their totals for a period, oldest joiner first. Affiliates with no activity in the period are omitted. Note 1: this endpoint is only accessible with a secret API key. Note 2: a period may span at most 90 days; request a longer window a period at a time. Note 3: up to 100 affiliates are returned per request; page through the rest with offset.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://winwinkit.mintlify.app/_mintlify/api/og/v2?division=Affiliates\u0026amp;title=Get+Affiliate+Analytics\u0026amp;description=Returns+the+project+affiliates+with+their+totals+for+a+period%2C+oldest+joiner+first.+Affiliates+with+no+activity+in+the+period+are+omitted.+Note+1%3A+this+endpoint\u0026amp;theme=2c0768838a8a88e320968c6a\u0026amp;signature=e785f3d2e51d1895946198178acf68764904c2ab924c3716d7898ddecc565c17\">\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/winwinkit/KktkmV8E25Jn2EDG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"WinWinKit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#111113\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.winwinkit.com/api-reference/affiliates/analytics\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/affiliates/analytics.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.winwinkit.com/#organization\",\"name\":\"WinWinKit\",\"url\":\"https://docs.winwinkit.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/winwinkit/oupABwSJKqsW2S9I/logo.svg?fit=max\u0026auto=format\u0026n=oupABwSJKqsW2S9I\u0026q=85\u0026s=b86c7815e871849dfcc12ff274566f7f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.winwinkit.com#website\",\"name\":\"WinWinKit\",\"url\":\"https://docs.winwinkit.com\",\"publisher\":{\"@id\":\"https://docs.winwinkit.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.winwinkit.com/api-reference/affiliates/analytics#webpage\",\"url\":\"https://docs.winwinkit.com/api-reference/affiliates/analytics\",\"name\":\"Get Affiliate Analytics\",\"description\":\"Returns the project affiliates with their totals for a period, oldest joiner first. Affiliates with no activity in the period are omitted. Note 1: this endpoint is only accessible with a secret API key. Note 2: a period may span at most 90 days; request a longer window a period at a time. Note 3: up to 100 affiliates are returned per request; page through the rest with offset.\",\"dateModified\":\"2026-09-21T09:22:12.203Z\",\"isPartOf\":{\"@id\":\"https://docs.winwinkit.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.winwinkit.com/api-reference/affiliates/analytics#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.winwinkit.com/api-reference/affiliates/analytics#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform API\",\"item\":\"https://docs.winwinkit.com/api-reference/users/delete-user\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Affiliates\",\"item\":\"https://docs.winwinkit.com/api-reference/affiliates/list-affiliates\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Affiliate Analytics\",\"item\":\"https://docs.winwinkit.com/api-reference/affiliates/analytics\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.winwinkit.com/api-reference/affiliates/analytics#apireference\",\"headline\":\"Get Affiliate Analytics\",\"name\":\"Get Affiliate Analytics\",\"description\":\"Returns the project affiliates with their totals for a period, oldest joiner first. Affiliates with no activity in the period are omitted. Note 1: this endpoint is only accessible with a secret API key. Note 2: a period may span at most 90 days; request a longer window a period at a time. Note 3: up to 100 affiliates are returned per request; page through the rest with offset.\",\"url\":\"https://docs.winwinkit.com/api-reference/affiliates/analytics\",\"mainEntityOfPage\":{\"@id\":\"https://docs.winwinkit.com/api-reference/affiliates/analytics#webpage\"},\"dateModified\":\"2026-09-21T09:22:12.203Z\",\"publisher\":{\"@id\":\"https://docs.winwinkit.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.winwinkit.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"WinWinKit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"WinWinKit","nav":{"global":null,"groups":[{"group":"Client API","pages":[{"group":"Users","pages":[{"openapi":"post /users","title":"Create or Update User","href":"/api-reference/users/create-or-update-user"},{"openapi":"get /users/{app_user_id}","title":"Get User","href":"/api-reference/users/get-user"}]},{"group":"User Rewards","pages":[{"openapi":"post /users/{app_user_id}/rewards/withdraw-credits","title":"Withdraw Credits","href":"/api-reference/rewards-actions/withdraw-credits"}]},{"group":"Claim Code","pages":[{"openapi":"post /users/{app_user_id}/claim-code","title":"Claim Code","href":"/api-reference/claim-actions/claim-code"}]},{"group":"Codes","pages":[{"openapi":"get /codes/{code}","title":"Get Code","href":"/api-reference/codes/get-code"}]},{"group":"Transactions","pages":[{"openapi":"post /users/{app_user_id}/transactions/app-store","title":"Register App Store Transaction","href":"/api-reference/transactions/app-store"},{"openapi":"post /users/{app_user_id}/transactions/google-play","title":"Register Google Play Transaction","href":"/api-reference/transactions/google-play"}]}]},{"group":"Platform API","pages":[{"group":"Users","pages":[{"openapi":"delete /users/{app_user_id}","title":"Delete User","href":"/api-reference/users/delete-user"}]},{"group":"Affiliates","pages":[{"openapi":"get /affiliates","title":"List Affiliates","description":"Returns the project approved affiliates with their group, all-time totals and connected platforms — the same data as the affiliates table in the dashboard. Newest joiner first unless `sort_by` names another field — then largest first, or A to Z for `name`. Note 1: this endpoint is only accessible with a secret API key. Note 2: up to 100 affiliates are returned per request; page through the rest with `offset`.","href":"/api-reference/affiliates/list-affiliates"},{"openapi":"get /affiliates/analytics","title":"Get Affiliate Analytics","href":"/api-reference/affiliates/analytics"}]},{"group":"Affiliate Payouts","pages":[{"openapi":"get /affiliates/{affiliate_id}/payouts","title":"List Affiliate Payouts","description":"Returns the affiliate's payouts from the project — the monthly `performance` payouts their codes earn, the `custom` ones the project created and the `base` ones paying their base rate — latest period first. Note 1: this endpoint is only accessible with a secret API key. Note 2: up to 100 payouts are returned per request; page through the rest with `offset`.","href":"/api-reference/affiliate-payouts/list-payouts"},{"openapi":"post /affiliates/{affiliate_id}/payouts","title":"Create a Custom Payout","href":"/api-reference/affiliate-payouts/create-custom-payout"},{"openapi":"delete /affiliates/{affiliate_id}/payouts/{payout_id}","title":"Cancel a Custom Payout","href":"/api-reference/affiliate-payouts/cancel-custom-payout"}]},{"group":"User Rewards","pages":[{"openapi":"post /users/{app_user_id}/rewards/grant","title":"Grant a Reward","href":"/api-reference/rewards-actions/grant-a-reward"}]}]}]},"basePath":"","title":"Get Affiliate Analytics - WinWinKit","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}