{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Lookup 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":"lookup-api-v3--developer-guide","__idx":0},"children":["Lookup 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 Lookup API V3 (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/lookup"]},")"]},{"$$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/lookup"},"children":["Lookup | 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":["The Lookup API resolves Sprinklr identifiers and reference values into human-readable entity details. It answers the question \"what is the entity behind this ID, or what IDs match this search term?\" — for example, resolving an assignment-skill ID into a skill name, resolving a custom field ID (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_c_<hex>"]},") taken from a report response into its readable name, or searching Facebook/Instagram places to obtain a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locationId"]}," before publishing a post."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["V3 exposes the API as ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["two POST operations on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/lookup"]}," resource"]},":"]},{"$$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":"th","attributes":{"data-label":"Request schema"},"children":["Request schema"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Use it when"},"children":["Use it when"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generic lookup (by ID)"]},{"$$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/lookup"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupRequest"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You already hold the entity IDs and want their details"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lookup by dimensions (by search query)"]},{"$$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/lookup/dimensions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DimensionsLookupDTO"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You have a search string, not an ID, and want matching entities with pagination"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The path change from V2 is limited to the version segment and the dimensions sub-path: V2 used ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v2/lookup"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v2/lookup/byDimensions"]},"; V3 uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/lookup"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/lookup/dimensions"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more details refer to the Lookup V3 API reference."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"11-choosing-between-the-two-operations","__idx":2},"children":["1.1 Choosing between the two operations"]},{"$$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":"You have"},"children":["You have"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A list of concrete IDs (account IDs, case IDs, skill IDs, custom field IDs)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keys[]"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A partial name or search term (a place name, an account name)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup/dimensions"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["query"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Both, for different entity families, in one round trip"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup/dimensions"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensionLookups[]"]}," accepts multiple lookup objects in a single request"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-base-urls-and-environments","__idx":3},"children":["2. Base URLs and environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","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 lookup resources are:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/lookup\nhttps://api3.sprinklr.com/{env}/api/v3/lookup/dimensions\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]}," with your assigned environment identifier (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod0"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod2"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod11"]},", and so on — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/apis"},"children":["APIs | Sprinklr Developer Portal"]}," for the environment list)."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-authentication-and-common-headers","__idx":4},"children":["3. Authentication and common headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All Lookup API calls are authenticated with OAuth 2.0. See the Authorize section on the developer portal for access-token generation and the Getting Started guide for API key generation."]},{"$$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":["******"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credential used by the API to authenticate a 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":["API key that 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":["All requests (both operations are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},")"]}]},{"$$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-lookup-operations","__idx":5},"children":["4. Lookup operations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both operations are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," requests, but neither creates or modifies data — the request body carries the query, not a resource to persist."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"41-generic-lookup--resolve-entities-by-id","__idx":6},"children":["4.1 Generic lookup — resolve entities by ID"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns details of entities identified by the IDs supplied in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keys"]},", for the entity family named by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body--lookuprequest-","__idx":7},"children":["Request body (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupRequest"]},")"]},{"$$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":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$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":["lookupType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Entity family to resolve. Required for lookup endpoint requests. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#7-supported-lookup-types"},"children":["§7"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keys"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String] (String, Integer per V2)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifiers related to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType"]},". Example: if ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT_ID"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keys"]}," holds account IDs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extraParams"]}]},{"$$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":["Additional parameters required by the given lookup type. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CUSTOM_FIELD"]},"."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required (within ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extraParams"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Asset type associated with the custom field. If the custom field applies to multiple asset types, supply any one of the applicable asset types."]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType"]}," differs from use case to use case. For example, when the lookup type is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ASSIGNMENT_SKILL"]},", the call resolves the skill IDs supplied in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keys"]}," into skill names."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request","__idx":8},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n  'https://api3.sprinklr.com/{env}/api/v3/lookup' \\\n  -H 'Authorization: ******' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'Accept: application/json' \\\n  -d '{\n    \"lookupType\": \"ACCOUNT_ID\",\n    \"keys\": [\n        \"600044848\"\n    ]\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request--lookuptype--assignment_skill","__idx":9},"children":["Request — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType = ASSIGNMENT_SKILL"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n  'https://api3.sprinklr.com/{env}/api/v3/lookup' \\\n  -H 'Authorization: ******' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'Accept: application/json' \\\n  -d '{\n    \"lookupType\": \"ASSIGNMENT_SKILL\",\n    \"keys\": [\n        \"5fbfc48accb38e37b031cb65\",\n        \"5e9fdead02ec853ab5c73c78\",\n        \"5eaff2c302ec853f2150258f\"\n    ]\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}," ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(illustrative example, based on the V2 reference payload and the V3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}," envelope)"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"5fbfc48accb38e37b031cb65\": \"skill 1\",\n    \"5e9fdead02ec853ab5c73c78\": \"skill 2\",\n    \"5eaff2c302ec853f2150258f\": \"skill 3\"\n  },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," is an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ID-keyed map"]},", not an array: each requested key maps to its resolved value. An ID that cannot be resolved is simply absent from the map — iterate your input list against the response keys rather than assuming positional alignment."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"42-lookup-by-dimensions--search-entities-by-query","__idx":10},"children":["4.2 Lookup by dimensions — search entities by query"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup/dimensions"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns entities that match a search string for one or more lookup types, with per-lookup pagination. For example, searching with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_PLACES_LOOKUP"]}," returns a unique location ID for every matching location."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body--dimensionslookupdto-","__idx":11},"children":["Request body (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DimensionsLookupDTO"]},")"]},{"$$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":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$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":["filters"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creates a new array of elements that pass the test implemented within the provided function. Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[]"]}," when no filtering is needed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensionLookups"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of objects that contain the query details. One entry per lookup."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Entity family to search. Required for lookup endpoint requests. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#7-supported-lookup-types"},"children":["§7"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["query"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The first four letters of the location you are looking for (V2 guidance for place lookups; for other lookup types, the search term for the entity name)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]},": Optional, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["size"]},": Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (Integer members)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Limits the number of items in the response when the result set is large. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," — the page number you want in the response; if no page number is provided, the first page is returned by default. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["size"]}," — the maximum number of results shown in a response."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (String values)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional key–value attributes for the lookup, per ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DimensionLookupDTO"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]},". Not documented on the V2 page."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters[]"]}," entries follow the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ExternalFilter"]}," schema: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensionName"]}," (String), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType"]}," (String), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}," (Array), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}," (Object)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-1","__idx":12},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n  'https://api3.sprinklr.com/{env}/api/v3/lookup/dimensions' \\\n  -H 'Authorization: ******' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'Accept: application/json' \\\n  -d '{\n    \"filters\": [],\n    \"dimensionLookups\": [\n        {\n            \"lookupType\": \"FACEBOOK_PLACES_LOOKUP\",\n            \"query\": \"cali\",\n            \"page\": {\n                \"page\": 0,\n                \"size\": 1\n            }\n        }\n    ]\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}," ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(illustrative example)"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"FACEBOOK_PLACES_LOOKUP\": {\n      \"hasMore\": true,\n      \"result\": [\n        {\n          \"id\": \"84115026000887\",\n          \"name\": \"ABC\",\n          \"address\": \"United States\",\n          \"location\": {\n            \"city\": \"Denver\",\n            \"state\": \"CO\",\n            \"country\": \"United States\",\n            \"zip\": \"80219\",\n            \"latitude\": 39.71184,\n            \"longitude\": -105.02464,\n            \"street\": \"253 S Federal Blvd\"\n          }\n        }\n      ]\n    }\n  },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For Instagram place lookups, the lookup type is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_PLACES_LOOKUP"]},". Once you have the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locationId"]},", pass it in the publishing request payload to attach the location to a post."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request--lookuptype--account_id","__idx":13},"children":["Request — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType = ACCOUNT_ID"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n  'https://api3.sprinklr.com/{env}/api/v3/lookup/dimensions' \\\n  -H 'Authorization: ******' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'Accept: application/json' \\\n  -d '{\n    \"filters\": [],\n    \"dimensionLookups\": [\n        {\n            \"lookupType\": \"ACCOUNT_ID\",\n            \"query\": \"Twitter\",\n            \"page\": {\n                \"page\": 0,\n                \"size\": 1\n            }\n        }\n    ]\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT_ID"]}," result objects carry account attributes including ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["displayName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["owner"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spaceId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partnerCustomProperties"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permalink"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deactivationReason"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleted"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"421-resolving-custom-fields-from-report-responses","__idx":14},"children":["4.2.1 Resolving custom fields from report responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Custom field lookups resolve user-defined metadata fields (for example, region, business unit, priority level):"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Identify the custom field ID in the report response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Extract the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_c_<alphanumeric_id>"]}," value from the report response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Resolve that ID through the Lookup API to obtain its readable name and values."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"43-operation-comparison","__idx":15},"children":["4.3 Operation comparison"]},{"$$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":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"POST /api/v3/lookup"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"POST /api/v3/lookup/dimensions"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup/dimensions"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Input"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keys[]"]}," (known IDs)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType"]}," + ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["query"]}," (search string)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupRequest"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DimensionsLookupDTO"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Multiple lookup types per call"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No — one ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType"]}," per request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes — one entry per ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensionLookups[]"]}," element"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pagination"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not documented"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.page"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.size"]},", with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hasMore"]}," per lookup type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Extra configuration"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extraParams.assetType"]}," (required for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CUSTOM_FIELD"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters[]"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-response-format-and-status-codes","__idx":16},"children":["5. Response format and status codes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"51-response-envelopes","__idx":17},"children":["5.1 Response envelopes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup"]}," declares the standard V3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}," envelope:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": { },\n  \"errors\": [],\n  \"metadata\": { }\n}\n","lang":"json"},"children":[]},{"$$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":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$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":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lookup results. Keyed by requested ID for the generic lookup; keyed by lookup type for the dimensions lookup."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Error]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error objects (empty when there are no errors)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors[].id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["24-character hex ObjectId (required)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors[].code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors[].message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dotted error key, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account.not.found"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response metadata. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ResponseMetadata"]}," is declared with no properties in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup/dimensions"]}," declares ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupResponse"]}," as its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," schema:"]},{"$$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":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$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":["hasMore"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether more results are available for the lookup"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["result"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Matching entities"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["totalHits"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (int32)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Total number of matches"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"52-response-codes","__idx":18},"children":["5.2 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":["Lookup completed and results returned"]}]},{"$$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 or invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keys"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensionLookups"]}]}]},{"$$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":["Caller lacks permission on the entity being resolved"]}]},{"$$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":["Not found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No matching entity for the request"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}," are the error responses declared for both operations in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]},". No ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}," response is declared for the Lookup paths."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-v2--v3-migration","__idx":19},"children":["6. V2 → V3 migration"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"61-endpoint-mapping","__idx":20},"children":["6.1 Endpoint mapping"]},{"$$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":"V2"},"children":["V2"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V3"},"children":["V3"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/lookup"]}," (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/lookup-by-id"},"children":["Lookup By Id"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/lookup/byDimensions"]}," (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/lookup-by-dimension"},"children":["Lookup By Dimension"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup/dimensions"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"62-what-changes","__idx":21},"children":["6.2 What changes"]},{"$$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":"Aspect"},"children":["Aspect"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API V2"},"children":["API V2"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API V3"},"children":["API V3"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Impact"},"children":["Impact"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Base path"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v2/lookup"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/lookup"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update the version segment"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dimensions sub-path"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["byDimensions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Rename required"]}," — the old sub-path does not carry over"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request body — generic lookup"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keys"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extraParams"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unchanged (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupRequest"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No payload change"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request body — dimensions lookup"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filters"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensionLookups[].lookupType"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["query"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unchanged, plus optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensionLookups[].additional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No payload change; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}," is new"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response envelope"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add tolerance for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}," object"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"7-supported-lookup-types","__idx":22},"children":["7. Supported lookup types"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"71-generic-lookup--post-apiv3lookup-","__idx":23},"children":["7.1 Generic lookup (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following Lookup types are supported: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT_ID"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER_ID"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CASE_ID"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CUSTOM_FIELD"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_PLACES_LOOKUP"]}," (for Instagram), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ASSIGNMENT_SKILL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LOCATION_IDS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMART_SEGMENT_ID"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ASSIGNMENT_SKILL"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"72-dimensions-lookup--post-apiv3lookupdimensions-","__idx":24},"children":["7.2 Dimensions lookup (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup/dimensions"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Generic lookup types"]}]},{"$$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":"Lookup type"},"children":["Lookup type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resolves"},"children":["Resolves"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT_ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Social accounts"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PARTNER_USERS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partner users"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Users"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CASE_ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cases"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CUSTOM_FIELD"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom fields"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FACEBOOK_PLACES_LOOKUP"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Places / location IDs (only for Instagram)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMART_SEGMENT_ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Smart segments"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CATALOG"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Catalogs"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Reporting Suite lookup types"]}]},{"$$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":"Entity"},"children":["Entity"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Lookup types"},"children":["Lookup types"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ad Set"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["adSetId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AD_SET_ID_AD_SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AD_SET_ID_AD_SET_NAME"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AD_SET_ID_NAME"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AD_SET_CHANNEL_ID"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AD_SET_CHANNEL_ID_NAME"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AD_SET_ID_LOOKUP"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Paid Initiative"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paidInitiativeId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAID_INITIATIVE_ID_PAID_INITIATIVE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAID_INITIATIVE_ID_NAME"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ad Variant"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["adVariantId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AD_VARIANT_ID_AD_VARIANT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AD_VARIANT_ID_NAME"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom field (CF) lookups resolve user-defined metadata fields, for example region, business unit, priority level"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For Reporting Suite, use the entity IDs that appear in exports and field mappings (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["adSetId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["paidInitiativeId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["adVariantId"]},") plus custom field lookups."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"8-use-cases","__idx":25},"children":["8. Use cases"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"81-tag-a-post-with-an-instagram-location","__idx":26},"children":["8.1 Tag a post with an Instagram location"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup/dimensions"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType: \"FACEBOOK_PLACES_LOOKUP\""]}," and the first four letters of the place name as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["query"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Read ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," from the result — this is the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locationId"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Pass the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["locationId"]}," in the publishing request payload."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"82-turn-a-report-export-into-readable-labels","__idx":27},"children":["8.2 Turn a report export into readable labels"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A report response returns opaque IDs. Extract the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_c_<alphanumeric_id>"]}," custom field IDs and resolve them in one ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup"]}," call with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType: \"CUSTOM_FIELD\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keys"]}," set to the extracted IDs, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["extraParams.assetType"]}," set to the applicable asset type. Cache the resulting ID → name map; custom field names change rarely."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"83-resolve-assignment-skills-on-a-case-view","__idx":28},"children":["8.3 Resolve assignment skills on a case view"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cases carry skill IDs, not skill names. Send the IDs in one ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup"]}," call with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType: \"ASSIGNMENT_SKILL\""]}," and read the ID-keyed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," map to label your UI. Batch all IDs on the screen into a single request rather than issuing one call per ID."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"84-build-an-account-picker-with-type-ahead","__idx":29},"children":["8.4 Build an account picker with type-ahead"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/lookup/dimensions"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType: \"ACCOUNT_ID\""]},", the typed text as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["query"]},", and a small ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.size"]}," (for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["10"]},"). Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["hasMore"]}," to decide whether to show a \"load more\" control, and increment ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page.page"]}," for the next page."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"85-resolve-several-entity-families-in-one-round-trip","__idx":30},"children":["8.5 Resolve several entity families in one round trip"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensionLookups[]"]}," accepts multiple objects, each with its own ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["query"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]},". A dashboard that needs both matching accounts and matching smart segments for the same search term can issue a single request instead of two."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["All JSON payloads in this guide are illustrative examples derived from the supplied Postman collection, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]},", and the published V2 references. They are not real customer data and are not guaranteed production responses. All credentials are placeholders (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["******"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{apiKey}}"]},") and must never be committed or logged."]}]}]},"headings":[{"value":"Lookup API V3 — Developer Guide","id":"lookup-api-v3--developer-guide","depth":1},{"value":"1. Overview","id":"1-overview","depth":2},{"value":"1.1 Choosing between the two operations","id":"11-choosing-between-the-two-operations","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. Lookup operations","id":"4-lookup-operations","depth":2},{"value":"4.1 Generic lookup — resolve entities by ID","id":"41-generic-lookup--resolve-entities-by-id","depth":3},{"value":"Request body ( LookupRequest )","id":"request-body--lookuprequest-","depth":4},{"value":"Request","id":"request","depth":4},{"value":"Request — lookupType = ASSIGNMENT_SKILL","id":"request--lookuptype--assignment_skill","depth":4},{"value":"4.2 Lookup by dimensions — search entities by query","id":"42-lookup-by-dimensions--search-entities-by-query","depth":3},{"value":"Request body ( DimensionsLookupDTO )","id":"request-body--dimensionslookupdto-","depth":4},{"value":"Request","id":"request-1","depth":4},{"value":"Request — lookupType = ACCOUNT_ID","id":"request--lookuptype--account_id","depth":4},{"value":"4.2.1 Resolving custom fields from report responses","id":"421-resolving-custom-fields-from-report-responses","depth":4},{"value":"4.3 Operation comparison","id":"43-operation-comparison","depth":3},{"value":"5. Response format and status codes","id":"5-response-format-and-status-codes","depth":2},{"value":"5.1 Response envelopes","id":"51-response-envelopes","depth":3},{"value":"5.2 Response codes","id":"52-response-codes","depth":3},{"value":"6. V2 → V3 migration","id":"6-v2--v3-migration","depth":2},{"value":"6.1 Endpoint mapping","id":"61-endpoint-mapping","depth":3},{"value":"6.2 What changes","id":"62-what-changes","depth":3},{"value":"7. Supported lookup types","id":"7-supported-lookup-types","depth":2},{"value":"7.1 Generic lookup ( POST /api/v3/lookup )","id":"71-generic-lookup--post-apiv3lookup-","depth":3},{"value":"7.2 Dimensions lookup ( POST /api/v3/lookup/dimensions )","id":"72-dimensions-lookup--post-apiv3lookupdimensions-","depth":3},{"value":"8. Use cases","id":"8-use-cases","depth":2},{"value":"8.1 Tag a post with an Instagram location","id":"81-tag-a-post-with-an-instagram-location","depth":3},{"value":"8.2 Turn a report export into readable labels","id":"82-turn-a-report-export-into-readable-labels","depth":3},{"value":"8.3 Resolve assignment skills on a case view","id":"83-resolve-assignment-skills-on-a-case-view","depth":3},{"value":"8.4 Build an account picker with type-ahead","id":"84-build-an-account-picker-with-type-ahead","depth":3},{"value":"8.5 Resolve several entity families in one round trip","id":"85-resolve-several-entity-families-in-one-round-trip","depth":3}],"frontmatter":{"seo":{"title":"Lookup API V3 — Developer Guide"}},"lastModified":"2026-10-12T04:13:20.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/developer-guides-v3/lookup-api-v3-developer-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}