{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"MerchantSpring Public API","colors":{"primary":"#3B5BDB","light":"#748ffc","dark":"#2f4ac7"},"logo":{"light":"https://mintcdn.com/merchantspring/rDHtkNl6EQCmoU2E/logo/light.svg?fit=max\u0026auto=format\u0026n=rDHtkNl6EQCmoU2E\u0026q=85\u0026s=82faf858a3e8cf7619a286472637b6cc","dark":"https://mintcdn.com/merchantspring/rDHtkNl6EQCmoU2E/logo/dark.svg?fit=max\u0026auto=format\u0026n=rDHtkNl6EQCmoU2E\u0026q=85\u0026s=cfe1bb343652114b7aefc57aa75eda7f"},"favicon":"https://mintcdn.com/merchantspring/-YIz02q54S0tRx8I/favicon.png?fit=max\u0026auto=format\u0026n=-YIz02q54S0tRx8I\u0026q=85\u0026s=6959ba900cd761ed7f0cc2d626871708","api":{"playground":{"display":"interactive","proxy":true}},"navbar":{"links":[{"href":"mailto:support@merchantspring.io","label":"Support"}],"primary":{"type":"button","label":"Application","href":"https://mm.merchantspring.io"}},"footer":{"socials":{"website":"https://merchantspring.io","linkedin":"https://www.linkedin.com/company/merchantspring","facebook":"https://www.facebook.com/MerchantSpring","youtube":"https://www.youtube.com/@merchantspring"}},"integrations":{"gtm":{"tagId":"GTM-M97TH2P"}},"contextual":{"options":["copy","claude","chatgpt","mcp","add-mcp","cursor","vscode","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"merchantspring","hasAudioNarration":false,"actualSubdomain":"merchantspring","customDomains":["docs.merchantspring.io"],"gitSource":{"type":"github","owner":"merchant-spring","repo":"mm-api-documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":false,"agentFeedback":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aebbe7fcec16a8f3971e7bd","clientVersion":"0.0.4124","searchFilterCounts":[{"language":"default","tag":"API V1","count":52},{"language":"default","tag":"MerchantSpring API","count":52},{"language":"default","tag":"Report","count":22},{"language":"default","tag":"Documentation","count":7},{"language":"default","tag":"Advertising","count":5},{"language":"default","tag":"Custom Group","count":5},{"language":"default","tag":"Guides","count":4},{"language":"default","tag":"Profitability","count":4},{"language":"default","tag":"Tag","count":4},{"language":"default","tag":"Getting Started","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"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":"editor-metadata","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},{"name":"live-agents","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/report/retrieve-vendor-sales-by-period-performance","slug":"/api-reference/report/retrieve-vendor-sales-by-period-performance","pageMetadata":{"title":"Retrieve vendor sales-by-period performance","description":"Retrieve aggregated revenue with advertising metrics for a merchant over the selected date range, grouped by the requested interval.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/view/vendorSalesByPeriod","href":"/api-reference/report/retrieve-vendor-sales-by-period-performance","autogeneratedByOpenApi":true},"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 aggregated revenue with advertising metrics for a merchant over the selected date range, grouped by the requested interval.\"\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":{"title":"Retrieve vendor sales-by-period performance","description":"Retrieve aggregated revenue with advertising metrics for a merchant over the selected date range, grouped by the requested interval.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/view/vendorSalesByPeriod","href":"/api-reference/report/retrieve-vendor-sales-by-period-performance","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["report"],"summary":"Retrieve vendor sales-by-period performance","description":"Retrieve aggregated revenue with advertising metrics for a merchant over the selected date range, grouped by the requested interval.","operationId":"getVendorSalesByPeriodReport","requestBody":"2461db7d-a8a2-4288-bca1-1e857eda2aa8","responses":{"200":"b3ff7044-dc15-4766-a928-b7b9bb174199","400":"26054ca6-8cc8-4c4e-a482-d231c279ada2","default":"548dc565-da2b-4b26-9302-3ac36bdf6b42"},"security":["7a375a52-1182-4d8b-ae07-037a94652599"],"method":"post","type":"path","servers":["631b8ffe-6811-4cc8-a385-a621f049829e","c5e859bd-5d31-42ca-b671-97edabefa642"],"path":"/reports/view/vendorSalesByPeriod","baseUrlOptions":["https://mm-api.merchantspring.io","https://mm-api-staging.merchantspring.io"],"title":"Retrieve vendor sales-by-period performance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"Report filters that identify the merchant, time range, and marketplace scope to evaluate.","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Payload used to request the vendor sales-by-period view report.","properties":{"merchantId":{"type":"string","description":"MerchantSpring merchant identifier for the account whose performance should be returned.","isRequired":true,"uniqueKey":"merchantId","typeLabel":"string"},"channelId":{"type":"string","description":"MerchantSpring channel identifier for the account whose performance should be returned.","isRequired":true,"uniqueKey":"channelId","typeLabel":"string"},"reportOptions":{"type":"object","description":"Defines the reporting window and comparison period that should be analysed.","required":["fromDate","toDate","priorFromDate","priorToDate","timezone","interval"],"properties":{"fromDate":{"type":"number","description":"Unix epoch time (seconds) representing the start of the reporting period","isRequired":true,"uniqueKey":"reportOptions.fromDate","typeLabel":"number"},"toDate":{"type":"number","description":"Unix epoch time (seconds) representing the end of the reporting period","isRequired":true,"uniqueKey":"reportOptions.toDate","typeLabel":"number"},"priorFromDate":{"type":"number","description":"Unix epoch time (seconds) representing the start of the comparison period","isRequired":true,"uniqueKey":"reportOptions.priorFromDate","typeLabel":"number"},"priorToDate":{"type":"number","description":"Unix epoch time (seconds) representing the end of the comparison period","isRequired":true,"uniqueKey":"reportOptions.priorToDate","typeLabel":"number"},"timezone":{"type":"string","description":"The timezone string you wish to see the report in (e.g. 'America/Los_Angeles') see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones","isRequired":true,"uniqueKey":"reportOptions.timezone","typeLabel":"string"},"interval":{"type":"string","enum":["y","Q","M","w","d","h"],"description":"Interval code that controls how results are bucketed (y=year, Q=quarter, M=month, w=week, d=day, h=hour).","isRequired":true,"uniqueKey":"reportOptions.interval","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"reportOptions","typeLabel":"object"},"asins":{"type":"array","description":"Optional list of ASINs to restrict the dataset to specific products.","items":{"type":"string","uniqueKey":"asins.items.[INDEX]","typeLabel":"string"},"uniqueKey":"asins","typeLabel":"string[]"}},"required":["merchantId","channelId","reportOptions"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"merchantId":"\u003cstring>","channelId":"\u003cstring>","reportOptions":{"fromDate":123,"toDate":123,"priorFromDate":123,"priorToDate":123,"timezone":"\u003cstring>"},"asins":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b3ff7044-dc15-4766-a928-b7b9bb174199":{"description":"Aggregated performance data grouped to match the requested interval.","headers":{"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"Successful response returned by the sales-by-period report endpoint.","properties":{"status":{"type":"string","enum":["success"],"description":"Indicates that the request completed successfully.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"currency":{"type":"string","description":"Currency code associated with the returned metrics.","isRequired":true,"uniqueKey":"currency","typeLabel":"string"},"formattedChartData":{"type":"array","description":"Display-ready metrics including formatted strings and comparison values for each interval.","items":{"type":"object","description":"Human-readable metrics pre-formatted using the requested currency and timezone.","properties":{"startTime":{"type":"string","description":"Formatted start timestamp for the time bucket (respecting the requested interval and timezone).","uniqueKey":"formattedChartData.items.[INDEX].startTime","typeLabel":"string"},"endTime":{"type":"string","description":"Formatted end timestamp for the time bucket (respecting the requested interval and timezone).","uniqueKey":"formattedChartData.items.[INDEX].endTime","typeLabel":"string"},"glanceViews":{"type":"integer","format":"int32","description":"Current-period glance views","uniqueKey":"formattedChartData.items.[INDEX].glanceViews","typeLabel":"integer\u003cint32>"},"priorGlanceViews":{"type":"integer","format":"int32","description":"Prior-period glance views","uniqueKey":"formattedChartData.items.[INDEX].priorGlanceViews","typeLabel":"integer\u003cint32>"},"orderedRevenue":{"type":"string","description":"Ordered revenue during the current period.","uniqueKey":"formattedChartData.items.[INDEX].orderedRevenue","typeLabel":"string"},"priorOrderedRevenue":{"type":"string","description":"Ordered revenue during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorOrderedRevenue","typeLabel":"string"},"orderedUnits":{"type":"integer","format":"int32","description":"Ordered units during the current period.","uniqueKey":"formattedChartData.items.[INDEX].orderedUnits","typeLabel":"integer\u003cint32>"},"priorOrderedUnits":{"type":"integer","format":"int32","description":"Ordered units during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorOrderedUnits","typeLabel":"integer\u003cint32>"},"conversionRate":{"type":"string","description":"Conversion rate during the current period.","uniqueKey":"formattedChartData.items.[INDEX].conversionRate","typeLabel":"string"},"priorConversionRate":{"type":"string","description":"Conversion rate during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorConversionRate","typeLabel":"string"},"retailPrice":{"type":"string","description":"Retail price during the current period.","uniqueKey":"formattedChartData.items.[INDEX].retailPrice","typeLabel":"string"},"priorRetailPrice":{"type":"string","description":"Retail price during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorRetailPrice","typeLabel":"string"},"shippedRevenue":{"type":"string","description":"Shipped revenue during the current period.","uniqueKey":"formattedChartData.items.[INDEX].shippedRevenue","typeLabel":"string"},"priorShippedRevenue":{"type":"string","description":"Shipped revenue during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorShippedRevenue","typeLabel":"string"},"shippedRevenueManufacturing":{"type":"string","description":"Shipped revenue manufacturing during the current period.","uniqueKey":"formattedChartData.items.[INDEX].shippedRevenueManufacturing","typeLabel":"string"},"priorShippedRevenueManufacturing":{"type":"string","description":"Shipped revenue manufacturing during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorShippedRevenueManufacturing","typeLabel":"string"},"shippedCogs":{"type":"string","description":"Shipped COGS during the current period.","uniqueKey":"formattedChartData.items.[INDEX].shippedCogs","typeLabel":"string"},"priorShippedCogs":{"type":"string","description":"Shipped COGS during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorShippedCogs","typeLabel":"string"},"shippedCogsManufacturing":{"type":"string","description":"Shipped COGS manufacturing during the current period.","uniqueKey":"formattedChartData.items.[INDEX].shippedCogsManufacturing","typeLabel":"string"},"priorShippedCogsManufacturing":{"type":"string","description":"Shipped COGS manufacturing during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorShippedCogsManufacturing","typeLabel":"string"},"shippedUnits":{"type":"integer","format":"int32","description":"Shipped units during the current period.","uniqueKey":"formattedChartData.items.[INDEX].shippedUnits","typeLabel":"integer\u003cint32>"},"priorShippedUnits":{"type":"integer","format":"int32","description":"Shipped units during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorShippedUnits","typeLabel":"integer\u003cint32>"},"shippedUnitsManufacturing":{"type":"integer","format":"int32","description":"Shipped units manufacturing during the current period.","uniqueKey":"formattedChartData.items.[INDEX].shippedUnitsManufacturing","typeLabel":"integer\u003cint32>"},"priorShippedUnitsManufacturing":{"type":"integer","format":"int32","description":"Shipped units manufacturing during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorShippedUnitsManufacturing","typeLabel":"integer\u003cint32>"},"adSales":{"type":"string","description":"Ad sales during the current period.","uniqueKey":"formattedChartData.items.[INDEX].adSales","typeLabel":"string"},"priorAdSales":{"type":"string","description":"Ad sales during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorAdSales","typeLabel":"string"},"adSpend":{"type":"string","description":"Ad spend during the current period.","uniqueKey":"formattedChartData.items.[INDEX].adSpend","typeLabel":"string"},"priorAdSpend":{"type":"string","description":"Ad spend during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorAdSpend","typeLabel":"string"},"acos":{"type":"string","description":"Advertising cost of sales during the current period.","uniqueKey":"formattedChartData.items.[INDEX].acos","typeLabel":"string"},"priorAcos":{"type":"string","description":"Advertising cost of sales during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorAcos","typeLabel":"string"},"tacosOrderedRevenue":{"type":"string","description":"Total advertising cost of sales against ordered revenue during the current period.","uniqueKey":"formattedChartData.items.[INDEX].tacosOrderedRevenue","typeLabel":"string"},"priorTacosOrderedRevenue":{"type":"string","description":"Total advertising cost of sales against ordered revenue during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorTacosOrderedRevenue","typeLabel":"string"},"tacosShippedRevenue":{"type":"string","description":"Total advertising cost of sales against shipped revenue, sourcing, during the current period.","uniqueKey":"formattedChartData.items.[INDEX].tacosShippedRevenue","typeLabel":"string"},"priorTacosShippedRevenue":{"type":"string","description":"Total advertising cost of sales against shipped revenue, sourcing, during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorTacosShippedRevenue","typeLabel":"string"},"tacosManufacturing":{"type":"string","description":"Total advertising cost of sales against shipped revenue, manufacturing, during the current period.","uniqueKey":"formattedChartData.items.[INDEX].tacosManufacturing","typeLabel":"string"},"priorTacosManufacturing":{"type":"string","description":"Total advertising cost of sales against shipped revenue, manufacturing, during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorTacosManufacturing","typeLabel":"string"},"impressions":{"type":"integer","format":"int32","description":"Impressions during the current period.","uniqueKey":"formattedChartData.items.[INDEX].impressions","typeLabel":"integer\u003cint32>"},"priorImpressions":{"type":"integer","format":"int32","description":"Impressions during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorImpressions","typeLabel":"integer\u003cint32>"},"clicks":{"type":"integer","format":"int32","description":"Clicks during the current period.","uniqueKey":"formattedChartData.items.[INDEX].clicks","typeLabel":"integer\u003cint32>"},"priorClicks":{"type":"integer","format":"int32","description":"Clicks during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorClicks","typeLabel":"integer\u003cint32>"},"clickThroughRate":{"type":"string","description":"Click through rate during the current period.","uniqueKey":"formattedChartData.items.[INDEX].clickThroughRate","typeLabel":"string"},"priorClickThroughRate":{"type":"string","description":"Click through rate during the comparison period.","uniqueKey":"formattedChartData.items.[INDEX].priorClickThroughRate","typeLabel":"string"},"currency":{"type":"string","description":"Currency code used when formatting the monetary totals.","uniqueKey":"formattedChartData.items.[INDEX].currency","typeLabel":"string"}},"uniqueKey":"formattedChartData.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"formattedChartData","typeLabel":"object[]"}},"required":["status","currency","formattedChartData"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"success","currency":"\u003cstring>","formattedChartData":[{"startTime":"\u003cstring>","endTime":"\u003cstring>","glanceViews":123,"priorGlanceViews":123,"orderedRevenue":"\u003cstring>","priorOrderedRevenue":"\u003cstring>","orderedUnits":123,"priorOrderedUnits":123,"conversionRate":"\u003cstring>","priorConversionRate":"\u003cstring>","retailPrice":"\u003cstring>","priorRetailPrice":"\u003cstring>","shippedRevenue":"\u003cstring>","priorShippedRevenue":"\u003cstring>","shippedRevenueManufacturing":"\u003cstring>","priorShippedRevenueManufacturing":"\u003cstring>","shippedCogs":"\u003cstring>","priorShippedCogs":"\u003cstring>","shippedCogsManufacturing":"\u003cstring>","priorShippedCogsManufacturing":"\u003cstring>","shippedUnits":123,"priorShippedUnits":123,"shippedUnitsManufacturing":123,"priorShippedUnitsManufacturing":123,"adSales":"\u003cstring>","priorAdSales":"\u003cstring>","adSpend":"\u003cstring>","priorAdSpend":"\u003cstring>","acos":"\u003cstring>","priorAcos":"\u003cstring>","tacosOrderedRevenue":"\u003cstring>","priorTacosOrderedRevenue":"\u003cstring>","tacosShippedRevenue":"\u003cstring>","priorTacosShippedRevenue":"\u003cstring>","tacosManufacturing":"\u003cstring>","priorTacosManufacturing":"\u003cstring>","impressions":123,"priorImpressions":123,"clicks":123,"priorClicks":123,"clickThroughRate":"\u003cstring>","priorClickThroughRate":"\u003cstring>","currency":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"26054ca6-8cc8-4c4e-a482-d231c279ada2":{"description":"Missing or invalid input","content":{"application/json":{"schema":{"type":"object","description":"Error payload returned when the sales-by-period request cannot be processed.","properties":{"status":{"type":"string","enum":["error"],"description":"Identifies the response as an error.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"string","description":"Human-readable explanation of what went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"548dc565-da2b-4b26-9302-3ac36bdf6b42":{"description":"Unexpected error","content":{"application/json":{"schema":{"type":"object","description":"Error payload returned when the sales-by-period request cannot be processed.","properties":{"status":{"type":"string","enum":["error"],"description":"Identifies the response as an error.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error":{"type":"string","description":"Human-readable explanation of what went wrong.","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["status","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"7a375a52-1182-4d8b-ae07-037a94652599":{"api_key":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"api_key"}}},"servers":{"631b8ffe-6811-4cc8-a385-a621f049829e":{"url":"https://mm-api.merchantspring.io","description":"Production"},"c5e859bd-5d31-42ca-b671-97edabefa642":{"url":"https://mm-api-staging.merchantspring.io","description":"Staging"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"api_key"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"x-api-key"}],"title":"api_key"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"merchantspring","siteName":"MerchantSpring Public API","title":"Retrieve vendor sales-by-period performance - MerchantSpring Public API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-04T23:23:50.130Z","originalFileLocation":"api-reference/report/retrieve-vendor-sales-by-period-performance.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;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=\"system\"}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 aggregated revenue with advertising metrics for a merchant over the selected date range, grouped by the requested interval.\">\u003cmeta data-mint-head name=\"application-name\" content=\"MerchantSpring Public 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/merchantspring/DL1hFT45kXMzcRYy/_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/merchantspring/DL1hFT45kXMzcRYy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/merchantspring/DL1hFT45kXMzcRYy/_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/merchantspring/DL1hFT45kXMzcRYy/_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/merchantspring/DL1hFT45kXMzcRYy/_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/merchantspring/DL1hFT45kXMzcRYy/_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/merchantspring/DL1hFT45kXMzcRYy/_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/merchantspring/DL1hFT45kXMzcRYy/_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/merchantspring/DL1hFT45kXMzcRYy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve vendor sales-by-period performance - MerchantSpring Public API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve aggregated revenue with advertising metrics for a merchant over the selected date range, grouped by the requested interval.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"MerchantSpring Public API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.merchantspring.io/api-reference/report/retrieve-vendor-sales-by-period-performance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://merchantspring.mintlify.site/_mintlify/api/og/v2?division=Report\u0026amp;title=Retrieve+vendor+sales-by-period+performance\u0026amp;description=Retrieve+aggregated+revenue+with+advertising+metrics+for+a+merchant+over+the+selected+date+range%2C+grouped+by+the+requested+interval.\u0026amp;theme=5bb8ab9139df01247030e552\u0026amp;signature=bebfabce5868924ab67a304ff0e9e491c69791e91c16fbfc6cb3287c1ef6f7ba\">\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=\"Retrieve vendor sales-by-period performance - MerchantSpring Public API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve aggregated revenue with advertising metrics for a merchant over the selected date range, grouped by the requested interval.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://merchantspring.mintlify.site/_mintlify/api/og/v2?division=Report\u0026amp;title=Retrieve+vendor+sales-by-period+performance\u0026amp;description=Retrieve+aggregated+revenue+with+advertising+metrics+for+a+merchant+over+the+selected+date+range%2C+grouped+by+the+requested+interval.\u0026amp;theme=5bb8ab9139df01247030e552\u0026amp;signature=bebfabce5868924ab67a304ff0e9e491c69791e91c16fbfc6cb3287c1ef6f7ba\">\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/merchantspring/DL1hFT45kXMzcRYy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"MerchantSpring Public API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3B5BDB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.merchantspring.io/api-reference/report/retrieve-vendor-sales-by-period-performance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/report/retrieve-vendor-sales-by-period-performance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.merchantspring.io/#organization\",\"name\":\"MerchantSpring Public API\",\"url\":\"https://docs.merchantspring.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/merchantspring/rDHtkNl6EQCmoU2E/logo/light.svg?fit=max\u0026auto=format\u0026n=rDHtkNl6EQCmoU2E\u0026q=85\u0026s=82faf858a3e8cf7619a286472637b6cc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.merchantspring.io#website\",\"name\":\"MerchantSpring Public API\",\"url\":\"https://docs.merchantspring.io\",\"publisher\":{\"@id\":\"https://docs.merchantspring.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.merchantspring.io/api-reference/report/retrieve-vendor-sales-by-period-performance#webpage\",\"url\":\"https://docs.merchantspring.io/api-reference/report/retrieve-vendor-sales-by-period-performance\",\"name\":\"Retrieve vendor sales-by-period performance\",\"description\":\"Retrieve aggregated revenue with advertising metrics for a merchant over the selected date range, grouped by the requested interval.\",\"dateModified\":\"2026-11-04T23:23:50.130Z\",\"isPartOf\":{\"@id\":\"https://docs.merchantspring.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.merchantspring.io/api-reference/report/retrieve-vendor-sales-by-period-performance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.merchantspring.io/api-reference/report/retrieve-vendor-sales-by-period-performance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"MerchantSpring API\",\"item\":\"https://docs.merchantspring.io/api-reference/channel/retrieve-a-list-of-channels\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Report\",\"item\":\"https://docs.merchantspring.io/api-reference/report/create-a-sales-by-product-report\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve vendor sales-by-period performance\",\"item\":\"https://docs.merchantspring.io/api-reference/report/retrieve-vendor-sales-by-period-performance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.merchantspring.io/api-reference/report/retrieve-vendor-sales-by-period-performance#apireference\",\"headline\":\"Retrieve vendor sales-by-period performance\",\"name\":\"Retrieve vendor sales-by-period performance\",\"description\":\"Retrieve aggregated revenue with advertising metrics for a merchant over the selected date range, grouped by the requested interval.\",\"url\":\"https://docs.merchantspring.io/api-reference/report/retrieve-vendor-sales-by-period-performance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.merchantspring.io/api-reference/report/retrieve-vendor-sales-by-period-performance#webpage\"},\"dateModified\":\"2026-11-04T23:23:50.130Z\",\"publisher\":{\"@id\":\"https://docs.merchantspring.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.merchantspring.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"MerchantSpring Public API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"MerchantSpring Public API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/report/retrieve-vendor-sales-by-period-performance.md","siteName":"MerchantSpring Public API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API V1","groups":[{"group":"MerchantSpring API","pages":[{"group":"Channel","pages":[{"title":"Retrieve a list of channels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /channels","href":"/api-reference/channel/retrieve-a-list-of-channels"}]},{"group":"Client Report","pages":[{"title":"List all sent and scheduled client reports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /clientReports","href":"/api-reference/client-report/list-all-sent-and-scheduled-client-reports"},{"title":"Get the status of a Client Report PDF generation request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /clientReports/generatePDF","href":"/api-reference/client-report/get-the-status-of-a-client-report-pdf-generation-request"},{"title":"Generate a PDF of a saved Client Report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /clientReports/generatePDF","href":"/api-reference/client-report/generate-a-pdf-of-a-saved-client-report"}]},{"group":"Content Change","pages":[{"title":"Retrieve a list of content changes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /content-changes","href":"/api-reference/content-change/retrieve-a-list-of-content-changes"}]},{"group":"Product","pages":[{"title":"Retrieve Amazon product attributes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /products/amazon","href":"/api-reference/product/retrieve-amazon-product-attributes"}]},{"group":"Search Query Performance","pages":[{"title":"Retrieve Search Query Performance data at the ASIN level (Amazon only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /search-query-performance/asins","href":"/api-reference/search-query-performance/retrieve-search-query-performance-data-at-the-asin-level-amazon-only"},{"title":"Retrieve Search Query Performance data at the keyword level for one ASIN (Amazon only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /search-query-performance/keywords","href":"/api-reference/search-query-performance/retrieve-search-query-performance-data-at-the-keyword-level-for-one-asin-amazon-only"}]},{"group":"Vendor","pages":[{"title":"Retrieve all vendor fields against an ASIN","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor/asins","href":"/api-reference/vendor/retrieve-all-vendor-fields-against-an-asin"}]},{"group":"Targets","pages":[{"title":"Retrieve budgets and forecasts (Ad Spend Budget, Sales Budget, Sales Forecast)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /targets","href":"/api-reference/targets/retrieve-budgets-and-forecasts-ad-spend-budget-sales-budget-sales-forecast"}]},{"group":"Order","pages":[{"title":"Retrieve a list of orders for an Amazon channel (Requires Enterprise plan)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /orders/amazon","href":"/api-reference/order/retrieve-a-list-of-orders-for-an-amazon-channel-requires-enterprise-plan"}]},{"group":"Report","pages":[{"title":"Create a sales by product report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/salesByProduct","href":"/api-reference/report/create-a-sales-by-product-report"},{"title":"Create a traffic and conversion report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/trafficAndConversion","href":"/api-reference/report/create-a-traffic-and-conversion-report"},{"title":"Create a cancellations and refunds report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/cancellationsAndRefunds","href":"/api-reference/report/create-a-cancellations-and-refunds-report"},{"title":"Create a customer lifetime value report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/customerLifetimeValue","href":"/api-reference/report/create-a-customer-lifetime-value-report"},{"title":"Create a shipped revenue report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/shippedRevenue","href":"/api-reference/report/create-a-shipped-revenue-report"},{"title":"Create an ordered revenue report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/orderedRevenue","href":"/api-reference/report/create-an-ordered-revenue-report"},{"title":"Create an inventory health report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/inventoryHealth","href":"/api-reference/report/create-an-inventory-health-report"},{"title":"Create a campaigns report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/campaigns","href":"/api-reference/report/create-a-campaigns-report"},{"title":"Create an inventory replenishment report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/inventoryReplenishment","href":"/api-reference/report/create-an-inventory-replenishment-report"},{"title":"Create a channel profit and loss report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/channelProfitAndLoss","href":"/api-reference/report/create-a-channel-profit-and-loss-report"},{"title":"Create an Amazon Buy Box Performance report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/amazonBuyBoxPerformance","href":"/api-reference/report/create-an-amazon-buy-box-performance-report"},{"title":"Create a repeat purchase report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/repeatPurchase","href":"/api-reference/report/create-a-repeat-purchase-report"},{"title":"Create a suppressed product report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/suppressedProduct","href":"/api-reference/report/create-a-suppressed-product-report"},{"title":"Create a marketing by product report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/marketingByProduct","href":"/api-reference/report/create-a-marketing-by-product-report"},{"title":"Create a subscribe and save report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/subscribeAndSave","href":"/api-reference/report/create-a-subscribe-and-save-report"},{"title":"Create a products report (Requires Enterprise plan)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/create/products","href":"/api-reference/report/create-a-products-report-requires-enterprise-plan"},{"title":"Get the status of a report request","description":"Get the status of a report request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reports/status/{reportId}","href":"/api-reference/report/get-the-status-of-a-report-request"},{"title":"Retrieve vendor sales-by-period performance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/view/vendorSalesByPeriod","href":"/api-reference/report/retrieve-vendor-sales-by-period-performance"},{"title":"Retrieve sales-by-period performance","description":"Retrieve aggregated GMV, traffic, and advertising metrics for a merchant over the selected date range, grouped by the requested interval.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/view/salesByPeriod","href":"/api-reference/report/retrieve-sales-by-period-performance"},{"title":"Retrieve advertising performance by channel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/view/advertisingByChannels","href":"/api-reference/report/retrieve-advertising-performance-by-channel"},{"title":"Retrieve sales performance by channel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/view/salesByChannel","href":"/api-reference/report/retrieve-sales-performance-by-channel"},{"title":"Retrieve sales performance by product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reports/view/salesByProduct","href":"/api-reference/report/retrieve-sales-performance-by-product"}]},{"group":"Profitability","pages":[{"title":"Get a store profit and loss","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /profitability/storeProfitAndLoss","href":"/api-reference/profitability/get-a-store-profit-and-loss"},{"title":"Retrieve single or multiple product profit and loss details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /profitability/productProfitAndLoss","href":"/api-reference/profitability/retrieve-single-or-multiple-product-profit-and-loss-details"},{"title":"Update Unit COGS","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /profitability/directCosts","href":"/api-reference/profitability/update-unit-cogs"},{"title":"Get the status of a Unit COGS update job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /profitability/directCostsJobStatus","href":"/api-reference/profitability/get-the-status-of-a-unit-cogs-update-job"}]},{"group":"Custom Group","pages":[{"title":"Retrieve custom groups for a channel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customGroups","href":"/api-reference/custom-group/retrieve-custom-groups-for-a-channel"},{"title":"Create a custom group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customGroups","href":"/api-reference/custom-group/create-a-custom-group"},{"title":"Retrieve a single custom group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customGroups/{id}","href":"/api-reference/custom-group/retrieve-a-single-custom-group"},{"title":"Delete a custom group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /customGroups/{id}","href":"/api-reference/custom-group/delete-a-custom-group"},{"title":"Update a custom group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /customGroups/{id}","href":"/api-reference/custom-group/update-a-custom-group"}]},{"group":"Tag","pages":[{"title":"Retrieve all tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tags","href":"/api-reference/tag/retrieve-all-tags"},{"title":"Retrieve tags from a specific channel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tags/channel","href":"/api-reference/tag/retrieve-tags-from-a-specific-channel"},{"title":"Add and/or remove tags on a specific channel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /tags/channel","href":"/api-reference/tag/add-andor-remove-tags-on-a-specific-channel"},{"title":"Convert a tag between private and shared","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tags/convert","href":"/api-reference/tag/convert-a-tag-between-private-and-shared"}]},{"group":"Advertising","pages":[{"title":"Retrieve multi-channel advertising campaign performance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /advertising/campaigns","href":"/api-reference/advertising/retrieve-multi-channel-advertising-campaign-performance"},{"title":"Retrieve multi-channel advertising ad group performance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /advertising/adGroups","href":"/api-reference/advertising/retrieve-multi-channel-advertising-ad-group-performance"},{"title":"Retrieve multi-channel advertising keyword performance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /advertising/keywords","href":"/api-reference/advertising/retrieve-multi-channel-advertising-keyword-performance"},{"title":"Retrieve multi-channel advertising product performance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /advertising/products","href":"/api-reference/advertising/retrieve-multi-channel-advertising-product-performance"},{"title":"Retrieve advertising search term performance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /advertising/searchTerms","href":"/api-reference/advertising/retrieve-advertising-search-term-performance"}]},{"group":"Seller Health","pages":[{"title":"Retrieve seller account health data for a channel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sellerHealth","href":"/api-reference/seller-health/retrieve-seller-account-health-data-for-a-channel"}]}]}]}]},"basePath":"","title":"Retrieve vendor sales-by-period performance - MerchantSpring Public API","buildId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","deploymentId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CDiBsYGW.js","utils-KF9rPlmF.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C26urKTX.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BdjmJAC1.js","snippetPresets-3IpDBjt3.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-D4x_2vvo.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BIWdc5Pa.js","shallow-LQqfiMNd.js","getApiPlaygroundDisplay-DryzlOZG.js","CodeSnippet-tcJujU4r.js","CodeSnippets-BHp0nVLL.js","Page-1CZdsdAn.js","getPastedJson-DU-1ayUv.js","icon-CZK2hPr4.js","MethodPill-DOaqmTFC.js","DuplicateIcon-B5-nUxxl.js","createIcon-CDP_U77G.js","DynamicMarkdown-GHvayGOn.js","SectionHeading-BYvpkmUD.js","axios-vUo_bRtp.js","Markdown-uxhlayGT.js","clsx-B35qUV0p.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BvrGG8gU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CAf0yVYe.js"]}