{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Reporting Suite API V3 — Developer Guide","description":"Sprinklr offers robust, convenient, and simple RESTful Web service APIs to integrate data from Sprinklr to any external system.","keywords":["Sprinklr API","Sprinklr Developer Portal","OAuth 2.0","RESTful API","Social Media API","Customer Experience API","Unified-CXM","Social Listening API"]},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"reporting-suite-api-v3--developer-guide","__idx":0},"children":["Reporting Suite API V3 — Developer Guide"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Applies to:"]}," Sprinklr Reporting Suite APIs V3"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/reporting-suite"},"children":["Reporting Suite APIs | Sprinklr Developer Portal"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-overview","__idx":1},"children":["1. Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sprinklr’s Reporting Suite APIs standardize data extraction through a predefined set of metrics and dimensions across all channels.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"A reporting suite is essentially a master template for analytics exports, ensuring consistency, efficiency, and reliability in how performance data is captured and shared."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"why-reporting-suites-matter","__idx":2},"children":["Why Reporting Suites Matter"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Brands often struggle to gain a complete view of campaign performance.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"They pull separate reports for each channel, repeat the process for every update, and manually export data for compliance.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"At the same time, reporting needs to evolve with campaigns, yet there is no simple way to sync data with internal systems.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"The Reporting Suite addresses these challenges with a unified, automated, and customizable framework for reporting."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"types-of-reporting-suites","__idx":3},"children":["Types of Reporting Suites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sprinklr offers two types of reporting suites:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"standard-reporting-suites","__idx":4},"children":["Standard Reporting Suites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These are pre-built reporting suites for common use cases and are ready to use immediately."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"custom-reporting-suites","__idx":5},"children":["Custom Reporting Suites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These are custom reporting suites that are customized according to your requirements.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"You can create these from scratch or clone a standard suite and modify it according to your needs.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"These are useful for industry-specific metrics, custom calculations, unique dimension combinations, and special export formats."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Reporting Suite V3 exposes full CRUD across multiple resource paths:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create suite"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/reportingSuite/suite"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search suites"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/reportingSuite/suite/search"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create export config"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/reportingSuite/exportConfig"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search export configs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/reportingSuite/exportConfig/search"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update suite (partial)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/reportingSuite/suite?entityId="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update export config"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/reportingSuite/exportConfig?entityId="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get suite by ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/reportingSuite/suite?entityId="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get export config by ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/reportingSuite/exportConfig?entityId="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch field mappings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/reportingSuite/fieldMappings?moduleType=&breakdownType="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete suite"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/reportingSuite/suite?entityId="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete export config"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/reportingSuite/exportConfig?entityId="]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-base-urls-and-environments","__idx":6},"children":["2. Base URLs and environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API calls are sent to the production endpoint:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["So the reporting suite resource in production is:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/reportingSuite\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]}," with your assigned environment identifier. The specification declares the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["env"]}," server variable with default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod"]}," and the following enumerated values:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod0"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod2"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod3"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod4"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod5"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod6"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod8"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod11"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod12"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod15"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod16"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod17"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod18"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod19"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod21"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod25"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/apis"},"children":["APIs | Sprinklr Developer Portal"]}," for the published environment list."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-authentication-and-common-headers","__idx":7},"children":["3. Authentication and common headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All Reporting Suite API calls are authenticated with OAuth 2.0. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/api-overview"},"children":["API Overview"]}," for portal registration, API key and secret generation, and the Authorize flow."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required on"},"children":["Required on"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer {{accessToken}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authenticates the user with the server"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{apiKey}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authenticates the application with the server"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declares the request body media type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declares the acceptable response type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-write-operations","__idx":8},"children":["4. Write operations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"41-create-a-reporting-suite","__idx":9},"children":["4.1 Create a reporting suite"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/reportingSuite/suite"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates a custom reporting suite to standardize analytics exports. You can define specific metrics and dimensions or clone a standard suite and extend it with additional fields, such as LinkedIn-specific metrics."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-parameters","__idx":10},"children":["Request body parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the reporting suite."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description of the suite’s purpose."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["moduleType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Module type for the suite.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAID"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REPORTING"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LISTENING"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MESSAGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breakdownType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of data breakdown. Must match the breakdownType of the standard reporting suite being cloned.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Values:"]}," See the breakdownType Values table below."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["baseReportingSuite"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ID of a standard suite to clone. If not specified, a new custom suite is created without cloning."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of dimension names to include. Values must be obtained from the Field Mappings API for the chosen ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["moduleType"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breakdownType"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"budget\", \"adFormat\"]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["measurements"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of measurement names to include. Values must be obtained from the Field Mappings API for the chosen ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["moduleType"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breakdownType"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"conversionRate\", \"reach\"]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["breakdownType Values"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"moduleType"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["moduleType"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Supported breakdownType values"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported breakdownType values"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PAID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Facebook:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_AD_SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_AD_VARIANT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_AGE_GENDER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_COUNTRY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_DESTINATION"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_DMA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_PAID_INITIATIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_PLATFORM_POSITION"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_PRODUCT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_REGION"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Google:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_AD_AGE_RANGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_AD_SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_AD_VARIANT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_DEVICE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_GENDER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_GEO"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_GEO_COUNTRY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_KEYWORD_STAT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_PAID_INITIATIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_PLACEMENT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_SEARCH_QUERY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_VIDEO"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["LinkedIn:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_AD_SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_AD_VARIANT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_COMPANY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_COUNTRY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_INDUSTRY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_JOB_TITLE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_PAID_INITIATIVE"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Snapchat:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_AD_SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_AD_VARIANT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_AGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_COUNTRY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_DMA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_GENDER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_INTEREST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_MAKE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_OS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_PAID_INITIATIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_PRODUCT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_REGION"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TikTok:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_AD_SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_AD_TYPE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_AD_VARIANT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_AGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_COUNTRY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_DMA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_GENDER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_INTEREST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_LANGUAGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_PAID_INITIATIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_PLACEMENT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_PLATFORM"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_PRODUCT"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["X (Twitter Ads):"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_AD_SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_AD_VARIANT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_AGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_AUCTION"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_EVENTS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_GENDER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_INTEREST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_KEYWORD"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_LOCATION"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_PAID_INITIATIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_PLATFORM"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REPORTING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CASE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_PAGE_*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_POST_*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INSTAGRAM_*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TWITTER_*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YOUTUBE_*"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["LISTENING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RESEARCH_INSIGHTS"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["MESSAGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MESSAGE"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request","__idx":11},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request POST 'https://api3.sprinklr.com/{env}/api/v3/reportingSuite/suite' \\\n--header 'Authorization: Bearer {Access Token}' \\\n--header 'Key: {API KEY}' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n  \"name\": \"Custom Facebook Initiative Suite\",\n  \"description\": \"Analyzes Facebook Initiative performance\",\n  \"breakdownType\": \"FACEBOOK_PAID_INITIATIVE\",\n  \"moduleType\": \"PAID\",\n  \"dimensions\": [\"paidInitiativeName\", \"currency\"],\n  \"measurements\": [\"clicks\", \"impressions\", \"spent\"]\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"42-search-reporting-suites","__idx":12},"children":["4.2 Search reporting suites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/reportingSuite/suite/search"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Searches for reporting suites with filters and pagination. You can filter results by suite type, module type, or other suite properties, and manage output using pagination."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-parameters-1","__idx":13},"children":["Request body parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Defines search criteria, including pagination, filters, and whether to return total counts."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-object","__idx":14},"children":["query Object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub-Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Parent object for pagination settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page number to retrieve (0-based index). Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["size"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of results per page. Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["50"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filter"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object containing filter details for narrowing down suites"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filterType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of filter operation. Supported: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AND"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OR"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GTE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LTE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NIN"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EQUALS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOT_EQUALS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Field name to filter on. Supported: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["suiteType"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["STANDARD"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CUSTOM"]},"), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["moduleType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breakdownType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["baseReportingSuite"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleted"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ownerUserId"]},", etc."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Value(s) to match against the field. Single string or array of values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String / Array"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["returnTotalCount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether to include total count of matching results. Supported: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-1","__idx":15},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request POST 'https://api3.sprinklr.com/{env}/api/v3/reportingSuite/suite/search' \\\n  -H 'Authorization: Bearer {Enter your Access Token}' \\\n  -H 'Key: {Enter your API KEY}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'accept: application/json'\n--data '{\n    \"query\": {\n        \"page\": {\n            \"page\": 0,\n            \"size\": 10\n        },\n        \"filter\": {\n            \"filterType\": \"EQUALS\",\n            \"field\": \"suiteType\",\n            \"values\": \"STANDARD\"\n        },\n        \"returnTotalCount\": true\n    },\n    \"searchStr\": \"\"\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"43-create-export-config","__idx":16},"children":["4.3 Create export config"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/reportingSuite/exportConfig"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates a new export configuration for a reporting suite. Supports both ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["one‑time"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["scheduled exports"]},", allowing automated delivery of reporting data to an external S3 storage location. You can customize exports by defining filters, specifying date ranges, and configuring schedules."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-parameters-2","__idx":17},"children":["Request body parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the export configuration"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["reportingSuite"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ID of the associated reporting suite.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Obtain this ID from suite creation or search.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["67a3494047906e5dd61ae727"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["exportType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of export.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ONE_TIME"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SCHEDULED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["externalStorageId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ID of the S3 storage location where the export will be delivered.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["67a4af1dd2643eb564239265"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["timeRangeFilter"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Defines the date range for the export. See ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["timeRangeFilter Object"]}," below."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["scheduleConfig"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Configuration for recurring exports. See ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["scheduleConfig Object"]}," below."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of filters to apply to the export data. See ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["filters Object"]}," below."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of Objects"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"timerangefilter-object","__idx":18},"children":["timeRangeFilter Object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub-Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["startTime"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Start timestamp for one-time exports (epoch ms).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1735705800000"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["endTime"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["End timestamp for one-time exports (epoch ms).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1738211400000"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["timeRange"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Date range preset for scheduled exports.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TODAY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YESTERDAY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["THIS_WEEK"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LAST_WEEK"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["THIS_MONTH"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LAST_MONTH"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DYNAMIC_DURATION"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["timezone"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Free‑form IANA zone ID string.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Examples:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UTC"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GMT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["dynamicTimeRange"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object defining a dynamic duration. Contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["durationUnit"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["durationValue"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["endingValue"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["durationUnit"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unit of time.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MINUTES"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HOURS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DAYS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WEEKS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MONTHS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YEARS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["durationValue"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Length of the dynamic duration.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["endingValue"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Offset from current time at which duration ends.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"scheduleconfig-object","__idx":19},"children":["scheduleConfig Object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub-Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["scheduleFrequency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Defines frequency settings for scheduled exports. Contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scheduleType"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["repeatFrequency"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["scheduleType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Frequency type.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DAILY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MINUTES"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["HOURLY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WEEKLY"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["repeatFrequency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Interval for scheduled exports.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["3"]}," (positive integer)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"filters-object","__idx":20},"children":["filters Object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filterType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of filter.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AND"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OR"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GTE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LTE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NIN"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EQUALS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOT_EQUALS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Field to filter on. Must be a valid dimension name from the suite’s field mapping.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Values to filter by.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[12345, 23414]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-2","__idx":21},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request POST 'https://api3.sprinklr.com/{env}/api/v3/reportingSuite/exportConfig' \\\n  -H 'Authorization: Bearer {Enter your Access Token}' \\\n  -H 'Key: {Enter your API KEY}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'accept: application/json'\n--data '{\n    \"name\": \"Ad Variant Schedule Export - one time\",\n    \"reportingSuite\": \"6a1e8b0a259e22bdc9eb2797\",\n    \"exportType\": \"ONE_TIME\",\n    \"timeRangeFilter\": {\n        \"startTime\": 1739100163000,\n        \"endTime\": 1739445763000,\n        \"timezone\": \"UTC\"\n    }\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"44-search-export-configs","__idx":22},"children":["4.4 Search export configs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/reportingSuite/exportConfig/search"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Searches for export configurations associated with reporting suites. You can filter results by export type, suite ID, or other properties, and manage output using pagination."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-parameters-3","__idx":23},"children":["Request body parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Defines the search criteria, including pagination, filters, and whether to return total counts. See the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["query Object"]}," table below."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-object-1","__idx":24},"children":["query Object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub-Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object containing pagination details for the search results."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page number to retrieve (0-based index).",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["size"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of results per page.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["10"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["50"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filter"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object containing filter details for narrowing down export configs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filterType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of filter operation.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AND"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OR"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GTE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LTE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NIN"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EQUALS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOT_EQUALS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINS"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dimension or property to filter on.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Examples:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ownerUserId"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Other searchable properties: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exportType"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ONE_TIME"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SCHEDULED"]},"), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reportingSuite"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalStorageId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleted"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["values"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String / Array of Strings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Value(s) to match against the chosen field. Always passed as an array, even if only one value.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"SCHEDULED\"]"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["returnTotalCount"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether to include the total count of matching results.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-3","__idx":25},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request POST 'https://api3.sprinklr.com/{env}/api/v3/reportingSuite/exportConfig/search' \\\n  -H 'Authorization: Bearer {Enter your Access Token}' \\\n  -H 'Key: {Enter your API KEY}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'accept: application/json'\n--data '{\n    \"query\": {\n        \"page\": {\n            \"page\": 0,\n            \"size\": 10\n        }\n    },\n    \"searchStr\": \"Schedule\"\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"45-update-reporting-suite","__idx":26},"children":["4.5 Update reporting suite"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/reportingSuite/suite"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Updates specific fields of an existing reporting suite. This endpoint allows you to modify suite metadata, dimensions, measurements, or filters after creation.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": Certain fields cannot be changed once the suite is created."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameter","__idx":27},"children":["Query parameter"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entityId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the reporting suite.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"You can obtain this from the response when creating a suite, or by searching for existing suites.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["67a3515847906e5dd61aea24"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-parameters-4","__idx":28},"children":["Request body parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fieldName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the field to update.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensions"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["measurements"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["baseReportingSuite"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Dev Notes:"]}," The following fields cannot be changed once the suite is created: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["suiteType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleted"]},". Modifying ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["moduleType"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breakdownType"]}," after suite creation is not recommended."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["value"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["New value for the specified field."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object / String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["op"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operation to perform on the field.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNSET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INC"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEC"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INCREMENT_BY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DECREMENT_BY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADD"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REMOVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUSH"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MERGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SET_IF_ABSENT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-4","__idx":29},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request PATCH 'https://api3.sprinklr.com/{env}/api/v3/reportingSuite/suite?entityId=6a1e6c3c259e22bdc9eb1c59' \\\n  -H 'Authorization: Bearer {Enter your Access Token}' \\\n  -H 'Key: {Enter your API KEY}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'accept: application/json'\n--data '{\n    \"updateFields\": {\n        \"op\": \"SET\",\n        \"fieldName\": \"dimensions\",\n        \"value\": [\n            \"linkedinMemberCompanyId\",\n            \"linkedinCompany\",\n            \"LinkedIn\"\n        ]\n    }\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"46-update-export-config","__idx":30},"children":["4.6 Update export config"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/reportingSuite/exportConfig"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Updates specific fields of an existing export configuration. This endpoint allows you to modify export settings such as filters, schedules, storage location, or time ranges after creation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameter-1","__idx":31},"children":["Query parameter"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entityId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the export config.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["67a3515847906e5dd61aea24"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-parameters-5","__idx":32},"children":["Request body parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fieldName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the field to update.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timeRangeFilter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scheduleConfig"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalStorageId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exportType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["value"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["New value for the specified field.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"startTime\": 1735705800000, \"endTime\": 1738211400000, \"timezone\": \"GMT\"}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object / String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["op"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operation to perform on the field.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNSET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INC"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEC"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INCREMENT_BY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DECREMENT_BY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADD"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REMOVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUSH"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MERGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SET_IF_ABSENT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-5","__idx":33},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request PATCH 'https://api3.sprinklr.com/{env}/api/v3/reportingSuite/exportConfig?entityId=6a1e8bcb259e22bdc9eb27d6' \\\n  -H 'Authorization: Bearer {Enter your Access Token}' \\\n  -H 'Key: {Enter your API KEY}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'accept: application/json'\n--data '{\n    \"updateFields\": {\n        \"op\": \"SET\",\n        \"fieldName\": \"name\",\n        \"value\": \"update export suite config\"\n    }\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-read-operations","__idx":34},"children":["5. Read operations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"51-read-field-mappings","__idx":35},"children":["5.1 Read field mappings"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/reportingSuite/fieldMappings"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves immutable field mappings used to define metrics and dimensions in reporting suites. These mappings standardize data extraction across channels, supporting the creation of custom reporting suites by providing available dimensions (for example, campaignName) and measurements (for example, clicks)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters","__idx":36},"children":["Query parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["moduleType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the module type for the mappings.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Values:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAID"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REPORTING"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LISTENING"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MESSAGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["breakdownType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filters mappings by a specific breakdown type. If not specified, the API returns all mappings for the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["moduleType"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported Values:"]}," See breakdownType table below."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"breakdowntype-values","__idx":37},"children":["breakdownType Values"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"moduleType"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["moduleType"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Supported breakdownType values"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported breakdownType values"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PAID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Facebook:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_AD_SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_AD_VARIANT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_AGE_GENDER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_COUNTRY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_DESTINATION"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_DMA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_PAID_INITIATIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_PLATFORM_POSITION"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_PRODUCT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_REGION"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Google:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_AD_AGE_RANGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_AD_SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_AD_VARIANT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_DEVICE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_GENDER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_GEO"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_GEO_COUNTRY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_KEYWORD_STAT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_PAID_INITIATIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_PLACEMENT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_SEARCH_QUERY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GOOGLE_VIDEO"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["LinkedIn:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_AD_SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_AD_VARIANT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_COMPANY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_COUNTRY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_INDUSTRY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_JOB_TITLE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_PAID_INITIATIVE"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Snapchat:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_AD_SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_AD_VARIANT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_AGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_COUNTRY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_DMA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_GENDER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_INTEREST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_MAKE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_OS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_PAID_INITIATIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_PRODUCT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_REGION"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["TikTok:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_AD_SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_AD_TYPE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_AD_VARIANT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_AGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_COUNTRY"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_DMA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_GENDER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_INTEREST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_LANGUAGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_PAID_INITIATIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_PLACEMENT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_PLATFORM"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_PRODUCT"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["X (Twitter Ads):"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_AD_SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_AD_VARIANT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_AGE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_AUCTION"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_EVENTS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_GENDER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_INTEREST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_KEYWORD"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_LOCATION"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_PAID_INITIATIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X_PLATFORM"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REPORTING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CASE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_PAGE_*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_POST_*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INSTAGRAM_*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LINKEDIN_*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SNAPCHAT_*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TIKTOK_*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TWITTER_*"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YOUTUBE_*"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["LISTENING"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RESEARCH_INSIGHTS"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["MESSAGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MESSAGE"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-6","__idx":38},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request GET 'https://api3.sprinklr.com/{env}/api/v3/reportingSuite/fieldMappings?moduleType=PAID&breakdownType=FACEBOOK_COUNTRY' \\\n  -H 'Authorization: Bearer {Enter your Access Token}' \\\n  -H 'Key: {Enter your API KEY}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"52-read-reporting-suite","__idx":39},"children":["5.2 Read reporting suite"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/reportingSuite/suite"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves detailed information about a specific reporting suite using its unique identifier. This endpoint is useful for inspecting the configuration of a suite, including its dimensions, measurements, and metadata, after creation or modification."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameter-2","__idx":40},"children":["Query parameter"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entityId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the reporting suite.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"You can obtain this ID from the response when you create a suite or when you search for suites.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["67a3494047906e5dd61ae727"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-7","__idx":41},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request GET 'https://api3.sprinklr.com/{env}/api/v3/reportingSuite/suite?entityId=6a97b9e25efb429a803919be'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"53-read-reporting-suite-export-config","__idx":42},"children":["5.3 Read reporting suite export config"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/reportingSuite/exportConfig"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves detailed information about a specific export configuration using its unique identifier. This endpoint allows users to inspect export settings, such as filters, schedules, and storage details, for auditing or modification purposes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameter-3","__idx":43},"children":["Query parameter"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entityId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the reporting suite.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"You can obtain this ID from the response when you create a suite or when you search for suites.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["67a3494047906e5dd61ae727"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-8","__idx":44},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request GET 'https://api3.sprinklr.com/{env}/api/v3/reportingSuite/exportConfig?entityId=6a97bac05efb429a803919c5' \\\n  -H 'Authorization: Bearer {Enter your Access Token}' \\\n  -H 'Key: {Enter your API KEY}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"54-read-export-run-status","__idx":45},"children":["5.4 Read export run status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/reportingSuite/exportStatus/"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves the status of export runs for a specific export configuration, including whether they are completed and providing download URLs for finished exports. This endpoint monitors queued or scheduled export processes managed by Sprinklr."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameter-4","__idx":46},"children":["Query Parameter"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exportConfigId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the export config.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["67a34bbe47906e5dd61ae7a4"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body-parameters-6","__idx":47},"children":["Request body parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub-Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Parent object for pagination settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page number for pagination.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2"]}," (non‑negative integers)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["size"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of items per page.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["10"]}," (positive integers)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["returnTotalCount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether to include total count of items.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request","__idx":48},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request POST 'https://api3.sprinklr.com/{env}/api/v3/reportingSuite/exportStatus/?exportConfigId=6a1e8bcb259e22bdc9eb27d6' \\\n--header 'Authorization: Bearer {Access Token}' \\\n--header 'Key: {API KEY}' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n    \"query\": {\n        \"page\": {\n            \"page\": 0,\n            \"size\": 10\n        },\n        \"returnTotalCount\": true\n    }\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-delete-operations","__idx":49},"children":["6. Delete operations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"61-delete-reporting-suite","__idx":50},"children":["6.1 Delete reporting suite"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/reportingSuite/suite"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deletes a specified reporting suite. This is useful for cleaning up unused or obsolete suites, ensuring only relevant configurations remain active."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameter-5","__idx":51},"children":["Query parameter"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{entityId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the reporting suite.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"You can obtain this from the response when creating a suite, or by searching for existing suites.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["67a3515847906e5dd61aea24"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-9","__idx":52},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request DELETE 'https://api3.sprinklr.com/{env}/api/v3/reportingSuite/suite?entityId=6a97a6615efb429a80391526' \\\n  -H 'Authorization: Bearer {Enter your Access Token}' \\\n  -H 'Key: {Enter your API KEY}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"62-delete-export-config","__idx":53},"children":["6.2 Delete export config"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/reportingSuite/exportConfig"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deletes a specified export configuration, stopping any associated scheduled exports and removing it from the system. This endpoint helps manage export configurations by eliminating obsolete or unnecessary ones."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameter-6","__idx":54},"children":["Query parameter"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required / Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required / Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entityId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the export config.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["67a3515847906e5dd61aea24"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-10","__idx":55},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request DELETE 'https://api3.sprinklr.com/{env}/api/v3/reportingSuite/exportConfig?entityId=6a97a70a5efb429a803915cd' \\\n  -H 'Authorization: Bearer {Enter your Access Token}' \\\n  -H 'Key: {Enter your API KEY}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"7-response-format-and-status-codes","__idx":56},"children":["7. Response format and status codes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"71-the-v3-envelope","__idx":57},"children":["7.1 The V3 envelope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reporting Suite API V3 endpoints return a consistent two‑part envelope:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n  },\n  \"errors\": []\n}\n\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["|| ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Field"]},"              | ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]},"          | ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}," |"," ","|-------------------------|-------------------|-----------------|"," ","| ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]},"                 | Array[Object]     | Array of suite or export config objects matching the request criteria |"," ","| ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]},"               | Array[Error]      | Array of error objects (empty if no errors) |"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"72-example-responses","__idx":58},"children":["7.2 Example responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create reporting suite"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"data\": {\n        \"id\": \"6a97b9e25efb429a803919be\",\n        \"entityId\": \"6a97b9e25efb429a803919be\",\n        \"suiteType\": \"CUSTOM\",\n        \"name\": \"LinkedIn Company BR2\",\n        \"description\": \"LinkedIn Company Level Performace for Ads11\",\n        \"dimensions\": [\n            \"linkedinMemberCompanyId\",\n            \"linkedinCompany\"\n        ],\n        \"measurements\": [\n            \"impressions\"\n        ],\n        \"moduleType\": \"PAID\",\n        \"breakdownType\": \"LINKEDIN_COMPANY\",\n        \"ownerUserId\": 66000149,\n        \"createdTime\": \"Sep 02, 2026, 05:53:38 AM\",\n        \"modifiedTime\": \"Sep 02, 2026, 05:53:38 AM\",\n        \"lastModifiedUserId\": 66000149,\n        \"deleted\": false\n    },\n    \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Search reporting suite"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"results\": [\n      {\n        \"id\": \"67d82467b64b120df93fe38f\",\n        \"entityId\": \"67d82467b64b120df93fe38f\",\n        \"suiteType\": \"STANDARD\",\n        \"name\": \"Facebook Ad Set\",\n        \"description\": \"Facebook Ad Set Level Performance\",\n        \"moduleType\": \"PAID\",\n        \"breakdownType\": \"FACEBOOK_AD_SET\",\n        \"dimensions\": [\"adObjective\", \"currency\", \"paidInitiative\", \"adSet\", \"date\", \"adChannel\", \"adAccount\", \"gender\", \"age\"],\n        \"measurements\": [\"spent\", \"impressions\", \"clicks\", \"dailyReach\", \"facebookLinkClicks\", \"facebookVideoPlays\"],\n        \"createdTime\": \"Mar 17, 2025, 01:32:23 PM\",\n        \"modifiedTime\": \"Mar 17, 2025, 01:32:23 PM\",\n        \"deleted\": false\n      },\n      {\n        \"id\": \"67d920aeca56fb471938fa6f\",\n        \"entityId\": \"67d920aeca56fb471938fa6f\",\n        \"suiteType\": \"STANDARD\",\n        \"name\": \"Facebook Ad Variant\",\n        \"description\": \"Facebook Ad Variant Level Performance\",\n        \"moduleType\": \"PAID\",\n        \"breakdownType\": \"FACEBOOK_AD_VARIANT\",\n        \"dimensions\": [\"adVariant\", \"adObjective\", \"currency\", \"paidInitiative\", \"adSet\", \"date\", \"adChannel\", \"adAccount\"],\n        \"measurements\": [\"spent\", \"impressions\", \"clicks\", \"dailyReach\", \"facebookLinkClicks\", \"facebookVideoPlays\"],\n        \"createdTime\": \"Mar 18, 2025, 07:28:46 AM\",\n        \"modifiedTime\": \"Mar 18, 2025, 07:28:47 AM\",\n        \"deleted\": false\n      },\n      {\n        \"id\": \"67d920f0ca56fb471938faff\",\n        \"entityId\": \"67d920f0ca56fb471938faff\",\n        \"suiteType\": \"STANDARD\",\n        \"name\": \"Facebook Initiative\",\n        \"description\": \"Facebook Paid Initiative Level Performance\",\n        \"moduleType\": \"PAID\",\n        \"breakdownType\": \"FACEBOOK_PAID_INITIATIVE\",\n        \"dimensions\": [\"adObjective\", \"currency\", \"paidInitiative\", \"date\", \"adChannel\", \"adAccount\"],\n        \"measurements\": [\"spent\", \"impressions\", \"clicks\", \"dailyReach\", \"facebookLinkClicks\"],\n        \"createdTime\": \"Mar 18, 2025, 07:29:52 AM\",\n        \"modifiedTime\": \"Mar 18, 2025, 07:29:52 AM\",\n        \"deleted\": false\n      }\n    ]\n  },\n  \"errors\": []\n}\n\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create export config"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"data\": {\n        \"id\": \"6a97d5c45efb429a803922b9\",\n        \"entityId\": \"6a97d5c45efb429a803922b9\",\n        \"name\": \"Ad Variant Schedule Export BR2\",\n        \"reportingSuite\": \"6a1e8b0a259e22bdc9eb2797\",\n        \"exportType\": \"ONE_TIME\",\n        \"timeRangeFilter\": {\n            \"startTime\": 1739100163000,\n            \"endTime\": 1739445763000,\n            \"timezone\": \"UTC\"\n        },\n        \"ownerUserId\": 66014658,\n        \"createdTime\": \"Sep 02, 2026, 07:52:36 AM\",\n        \"modifiedTime\": \"Sep 02, 2026, 07:52:39 AM\",\n        \"lastModifiedUserId\": 66014658,\n        \"deleted\": false\n    },\n    \"errors\": []\n}\n\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Search export config"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"results\": [\n      {\n        \"id\": \"67b5fcf97f63067cacbea917\",\n        \"entityId\": \"67b5fcf97f63067cacbea917\",\n        \"name\": \"Ad Variant Schedule Export - one time\",\n        \"reportingSuite\": \"67b5fc887f63067cacbea8db\",\n        \"exportType\": \"ONE_TIME\",\n        \"timeRangeFilter\": {\n          \"startTime\": 1739100163000,\n          \"endTime\": 1739445763000,\n          \"timezone\": \"UTC\"\n        },\n        \"createdTime\": \"Feb 19, 2025, 03:47:05 PM\",\n        \"deleted\": false\n      },\n      {\n        \"id\": \"67b6f76be0d90b2d088fa825\",\n        \"entityId\": \"67b6f76be0d90b2d088fa825\",\n        \"name\": \"Ad Variant Schedule Export - one time\",\n        \"reportingSuite\": \"67b6c5afe0d90b2d088fa0f9\",\n        \"exportType\": \"ONE_TIME\",\n        \"timeRangeFilter\": {\n          \"startTime\": 1739100163000,\n          \"endTime\": 1739445763000,\n          \"timezone\": \"UTC\"\n        },\n        \"externalStorageId\": \"abc\",\n        \"createdTime\": \"Feb 20, 2025, 09:35:39 AM\",\n        \"deleted\": false\n      },\n      {\n        \"id\": \"67b6fb9de0d90b2d088fa94b\",\n        \"entityId\": \"67b6fb9de0d90b2d088fa94b\",\n        \"name\": \"Ad Variant Schedule Export - one time\",\n        \"reportingSuite\": \"67b6fb80e0d90b2d088fa935\",\n        \"exportType\": \"ONE_TIME\",\n        \"timeRangeFilter\": {\n          \"startTime\": 1739100163000,\n          \"endTime\": 1839445763000,\n          \"timezone\": \"UTC\"\n        },\n        \"externalStorageId\": \"abc\",\n        \"createdTime\": \"Feb 20, 2025, 09:53:33 AM\",\n        \"deleted\": false\n      }\n    ],\n    \"hasMore\": true,\n    \"totalCount\": 0\n  },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Update reporting suite"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"204 No Content\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Update export config"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"204 No Content\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Read reporting suite"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"data\": [\n        {\n            \"id\": \"6a97b9e25efb429a803919be\",\n            \"entityId\": \"6a97b9e25efb429a803919be\",\n            \"suiteType\": \"CUSTOM\",\n            \"name\": \"LinkedIn Company BR2\",\n            \"description\": \"LinkedIn Company Level Performace for Ads11\",\n            \"dimensions\": [\n                \"linkedinMemberCompanyId\",\n                \"linkedinCompany\"\n            ],\n            \"measurements\": [\n                \"impressions\"\n            ],\n            \"moduleType\": \"PAID\",\n            \"breakdownType\": \"LINKEDIN_COMPANY\",\n            \"ownerUserId\": 66000149,\n            \"createdTime\": \"Sep 02, 2026, 05:53:38 AM\",\n            \"modifiedTime\": \"Sep 02, 2026, 05:53:38 AM\",\n            \"lastModifiedUserId\": 66000149,\n            \"deleted\": false\n        }\n    ],\n    \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Read export config"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"data\": [\n        {\n            \"id\": \"6a97bac05efb429a803919c5\",\n            \"entityId\": \"6a97bac05efb429a803919c5\",\n            \"name\": \"Ad Variant Schedule Export BR2\",\n            \"reportingSuite\": \"6a1e8b0a259e22bdc9eb2797\",\n            \"exportType\": \"ONE_TIME\",\n            \"timeRangeFilter\": {\n                \"startTime\": 1739100163000,\n                \"endTime\": 1739445763000,\n                \"timezone\": \"UTC\"\n            },\n            \"ownerUserId\": 66014658,\n            \"createdTime\": \"Sep 02, 2026, 05:57:20 AM\",\n            \"modifiedTime\": \"Sep 02, 2026, 05:57:20 AM\",\n            \"lastModifiedUserId\": 66014658,\n            \"deleted\": false\n        }\n    ],\n    \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Read export run status"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"results\": [\n      {\n        \"id\": \"67d2a86d2627b839008e9468\",\n        \"exportConfigId\": \"67d2a86d2627b839008e9461\",\n        \"status\": \"SUCCESS\",\n        \"downloadUrl\": \"https://dummy-url.com/export/67d2a86d2627b839008e9461_20250224_20250225.json\",\n        \"runTimestamp\": \"Mar 13, 2025, 09:42:05 AM\",\n        \"createdTimestamp\": \"Mar 13, 2025, 09:42:05 AM\",\n        \"exportSinceTime\": 1740375386000,\n        \"exportUntilTime\": 1740461786000,\n        \"createdTime\": 1741858925345\n      },\n      {\n        \"id\": \"67d2a86d2627b839008e9466\",\n        \"exportConfigId\": \"67d2a86d2627b839008e9461\",\n        \"status\": \"SUCCESS\",\n        \"downloadUrl\": \"https://dummy-url.com/export/67d2a86d2627b839008e9461_20250222_20250223.json\",\n        \"runTimestamp\": \"Mar 13, 2025, 09:42:05 AM\",\n        \"createdTimestamp\": \"Mar 13, 2025, 09:42:05 AM\",\n        \"exportSinceTime\": 1740202586000,\n        \"exportUntilTime\": 1740288986000,\n        \"createdTime\": 1741858925342\n      },\n      {\n        \"id\": \"67d2a86d2627b839008e9464\",\n        \"exportConfigId\": \"67d2a86d2627b839008e9461\",\n        \"status\": \"SUCCESS\",\n        \"downloadUrl\": \"https://dummy-url.com/export/67d2a86d2627b839008e9461_20250220_20250221.json\",\n        \"runTimestamp\": \"Mar 13, 2025, 09:42:05 AM\",\n        \"createdTimestamp\": \"Mar 13, 2025, 09:42:05 AM\",\n        \"exportSinceTime\": 1740029786000,\n        \"exportUntilTime\": 1740116186000,\n        \"createdTime\": 1741858925339\n      },\n      {\n        \"id\": \"67d2a86d2627b839008e9462\",\n        \"exportConfigId\": \"67d2a86d2627b839008e9461\",\n        \"status\": \"SUCCESS\",\n        \"downloadUrl\": \"https://dummy-url.com/export/67d2a86d2627b839008e9461_20250218_20250219.json\",\n        \"runTimestamp\": \"Mar 13, 2025, 09:42:05 AM\",\n        \"createdTimestamp\": \"Mar 13, 2025, 09:42:05 AM\",\n        \"exportSinceTime\": 1739856986000,\n        \"exportUntilTime\": 1739943386000,\n        \"createdTime\": 1741858925329\n      }\n    ],\n    \"hasMore\": false,\n    \"totalCount\": 4\n  },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delete Reporting Suite"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"204 No Content\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delete Export Config"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"204 No Content\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"73-response-codes","__idx":59},"children":["7.3 Response codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Code"},"children":["HTTP Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scenario"},"children":["Scenario"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Profiles found and returned successfully"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid Parameters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing required parameters or invalid parameter combinations"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication Failed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid or missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Insufficient Permissions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User lacks ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VIEW"]}," permission for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUDIENCE_PROFILE"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No Profiles Found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No profiles match the search criteria"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500 Internal Server Error"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server Error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unexpected server-side error occurred"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"7-v2--v3-migration","__idx":60},"children":["7. V2 → V3 migration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Reporting Suite APIs have been redesigned in V3 for consistency and clarity.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Here’s a comparison of V2 vs V3 endpoints and behavior:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Operation"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V2 Endpoint"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 Endpoint"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V3 Endpoint"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V3 Endpoint"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Key Differences"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Differences"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch Field Mappings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/reporting-suite/field-mappings/{moduleType}?breakdownType="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/reportingSuite/fieldMappings?moduleType=&breakdownType="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 used path parameter for moduleType; V3 uses query parameters for both moduleType and breakdownType."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create Suite"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/reporting-suite/suite"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/reportingSuite/suite"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Endpoint path changed; request/response envelope standardized in V3."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch Suite by ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/reporting-suite/suite/{entityId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/reportingSuite/suite?entityId="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 used path parameter; V3 uses query parameter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search Suites"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/reporting-suite/suite/search"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/reportingSuite/suite/search"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Same operation; V3 response envelope includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}," for pagination."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update Suite"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v2/reporting-suite/suite/{entityId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/reportingSuite/suite?entityId="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 used path parameter; V3 uses query parameter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete Suite"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v2/reporting-suite/suite/{entityId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/reportingSuite/suite?entityId="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 used path parameter; V3 uses query parameter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create Export Config"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/reporting-suite/export-config"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/reportingSuite/exportConfig"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Endpoint path changed; V3 supports richer ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["timeRangeFilter"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scheduleConfig"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch Export Config by ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/reporting-suite/export-config/{entityId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/reportingSuite/exportConfig?entityId="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 used path parameter; V3 uses query parameter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Search Export Configs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/reporting-suite/export-config/search"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/reportingSuite/exportConfig/search"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Same operation; V3 response envelope standardized with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update Export Config"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v2/reporting-suite/export-config/{entityId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/reportingSuite/exportConfig?entityId="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 used path parameter; V3 uses query parameter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete Export Config"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v2/reporting-suite/export-config/{entityId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/reportingSuite/exportConfig?entityId="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 used path parameter; V3 uses query parameter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch Export Run Status"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/reporting-suite/export-status/{exportConfigId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/reportingSuite/exportStatus?exportConfigId="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 used path parameter; V3 uses query parameter. Request body structure aligned with other V3 search endpoints."]}]}]}]}]}]},"headings":[{"value":"Reporting Suite API V3 — Developer Guide","id":"reporting-suite-api-v3--developer-guide","depth":1},{"value":"1. Overview","id":"1-overview","depth":2},{"value":"Why Reporting Suites Matter","id":"why-reporting-suites-matter","depth":2},{"value":"Types of Reporting Suites","id":"types-of-reporting-suites","depth":2},{"value":"Standard Reporting Suites","id":"standard-reporting-suites","depth":3},{"value":"Custom Reporting Suites","id":"custom-reporting-suites","depth":3},{"value":"2. Base URLs and environments","id":"2-base-urls-and-environments","depth":2},{"value":"3. Authentication and common headers","id":"3-authentication-and-common-headers","depth":2},{"value":"4. Write operations","id":"4-write-operations","depth":2},{"value":"4.1 Create a reporting suite","id":"41-create-a-reporting-suite","depth":3},{"value":"Request body parameters","id":"request-body-parameters","depth":4},{"value":"Request","id":"request","depth":4},{"value":"4.2 Search reporting suites","id":"42-search-reporting-suites","depth":3},{"value":"Request body parameters","id":"request-body-parameters-1","depth":4},{"value":"query Object","id":"query-object","depth":4},{"value":"Request","id":"request-1","depth":4},{"value":"4.3 Create export config","id":"43-create-export-config","depth":3},{"value":"Request body parameters","id":"request-body-parameters-2","depth":4},{"value":"timeRangeFilter Object","id":"timerangefilter-object","depth":4},{"value":"scheduleConfig Object","id":"scheduleconfig-object","depth":4},{"value":"filters Object","id":"filters-object","depth":4},{"value":"Request","id":"request-2","depth":4},{"value":"4.4 Search export configs","id":"44-search-export-configs","depth":3},{"value":"Request body parameters","id":"request-body-parameters-3","depth":4},{"value":"query Object","id":"query-object-1","depth":4},{"value":"Request","id":"request-3","depth":4},{"value":"4.5 Update reporting suite","id":"45-update-reporting-suite","depth":3},{"value":"Query parameter","id":"query-parameter","depth":4},{"value":"Request body parameters","id":"request-body-parameters-4","depth":4},{"value":"Request","id":"request-4","depth":4},{"value":"4.6 Update export config","id":"46-update-export-config","depth":3},{"value":"Query parameter","id":"query-parameter-1","depth":4},{"value":"Request body parameters","id":"request-body-parameters-5","depth":4},{"value":"Request","id":"request-5","depth":4},{"value":"5. Read operations","id":"5-read-operations","depth":2},{"value":"5.1 Read field mappings","id":"51-read-field-mappings","depth":3},{"value":"Query parameters","id":"query-parameters","depth":4},{"value":"breakdownType Values","id":"breakdowntype-values","depth":4},{"value":"Request","id":"request-6","depth":4},{"value":"5.2 Read reporting suite","id":"52-read-reporting-suite","depth":3},{"value":"Query parameter","id":"query-parameter-2","depth":4},{"value":"Request","id":"request-7","depth":4},{"value":"5.3 Read reporting suite export config","id":"53-read-reporting-suite-export-config","depth":3},{"value":"Query parameter","id":"query-parameter-3","depth":4},{"value":"Request","id":"request-8","depth":4},{"value":"5.4 Read export run status","id":"54-read-export-run-status","depth":3},{"value":"Query Parameter","id":"query-parameter-4","depth":4},{"value":"Request body parameters","id":"request-body-parameters-6","depth":4},{"value":"Example Request","id":"example-request","depth":4},{"value":"6. Delete operations","id":"6-delete-operations","depth":2},{"value":"6.1 Delete reporting suite","id":"61-delete-reporting-suite","depth":3},{"value":"Query parameter","id":"query-parameter-5","depth":4},{"value":"Request","id":"request-9","depth":4},{"value":"6.2 Delete export config","id":"62-delete-export-config","depth":3},{"value":"Query parameter","id":"query-parameter-6","depth":4},{"value":"Request","id":"request-10","depth":4},{"value":"7. Response format and status codes","id":"7-response-format-and-status-codes","depth":2},{"value":"7.1 The V3 envelope","id":"71-the-v3-envelope","depth":3},{"value":"7.2 Example responses","id":"72-example-responses","depth":3},{"value":"7.3 Response codes","id":"73-response-codes","depth":3},{"value":"7. V2 → V3 migration","id":"7-v2--v3-migration","depth":2}],"frontmatter":{"seo":{"title":"Reporting Suite API V3 — Developer Guide"}},"lastModified":"2026-10-17T16:47:08.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/developer-guides-v3/reporting-suite-api-v3-developer-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}