{
  "info": {
    "_postman_id": "a056eb00-1b26-417d-b6b8-eeb65cc6ed00",
    "name": "Coveo Activity Activities Synonym Preview API",
    "description": "API for Coveo Platform\n\nContact Support:\n Name: Coveo",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "createdAt": "2026-07-28T01:33:14.000Z",
    "updatedAt": "2026-07-28T01:33:14.000Z",
    "lastUpdatedBy": "35240",
    "uid": "35240-a056eb00-1b26-417d-b6b8-eeb65cc6ed00"
  },
  "item": [
    {
      "name": "rest",
      "item": [
        {
          "name": "organizations",
          "item": [
            {
              "name": "{organizationId}",
              "item": [
                {
                  "name": "commerce",
                  "item": [
                    {
                      "name": "v2",
                      "item": [
                        {
                          "name": "search",
                          "item": [
                            {
                              "name": "preview",
                              "item": [
                                {
                                  "name": "synonyms",
                                  "item": [
                                    {
                                      "name": "new",
                                      "item": [
                                        {
                                          "name": "Preview the Impact of a Synonym Rule",
                                          "id": "5a6128c0-6a7d-4b25-a46a-e3956b1ba40f",
                                          "protocolProfileBehavior": {
                                            "disableBodyPruning": true
                                          },
                                          "request": {
                                            "method": "POST",
                                            "header": [
                                              {
                                                "key": "Content-Type",
                                                "value": "application/json"
                                              },
                                              {
                                                "key": "Accept",
                                                "value": "*/*"
                                              }
                                            ],
                                            "body": {
                                              "mode": "raw",
                                              "raw": "{\n  \"country\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"language\": \"<string>\",\n  \"query\": \"<string>\",\n  \"page\": \"<integer>\",\n  \"perPage\": 30,\n  \"synonym\": {\n    \"action\": \"one-way\",\n    \"from\": [\n      \"<string>\"\n    ],\n    \"id\": \"<uuid>\",\n    \"to\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"locales\": [\n      {\n        \"language\": \"<string>\",\n        \"country\": \"<string>\",\n        \"currency\": \"<string>\"\n      },\n      {\n        \"language\": \"<string>\",\n        \"country\": \"<string>\",\n        \"currency\": \"<string>\"\n      }\n    ],\n    \"updatedAt\": \"<string>\"\n  },\n  \"debug\": \"<boolean>\",\n  \"additionalFields\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}",
                                              "options": {
                                                "raw": {
                                                  "headerFamily": "json",
                                                  "language": "json"
                                                }
                                              }
                                            },
                                            "url": {
                                              "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/search/preview/synonyms/new?trackingId=<string>&id=<uuid>",
                                              "host": [
                                                "{{baseUrl}}"
                                              ],
                                              "path": [
                                                "rest",
                                                "organizations",
                                                ":organizationId",
                                                "commerce",
                                                "v2",
                                                "search",
                                                "preview",
                                                "synonyms",
                                                "new"
                                              ],
                                              "query": [
                                                {
                                                  "description": "(Required) The unique identifier of the tracking target.",
                                                  "key": "trackingId",
                                                  "value": "<string>"
                                                },
                                                {
                                                  "description": "A UUID identifying the synonym rule.",
                                                  "key": "id",
                                                  "value": "<uuid>"
                                                }
                                              ],
                                              "variable": [
                                                {
                                                  "id": "0fbcdd72-1199-48ae-8fd9-7438fec66b9e",
                                                  "key": "organizationId",
                                                  "value": "<string>",
                                                  "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
                                                }
                                              ]
                                            },
                                            "description": "Previews the impact of a synonym rule.</br></br>**Required privilege:** Execute Query<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"targetId\":\"*\"}\n```\n</details>"
                                          },
                                          "response": [
                                            {
                                              "id": "ae4e7df3-d71f-4186-858c-08950b481018",
                                              "name": "OK",
                                              "originalRequest": {
                                                "method": "POST",
                                                "header": [
                                                  {
                                                    "key": "Content-Type",
                                                    "value": "application/json"
                                                  },
                                                  {
                                                    "key": "Accept",
                                                    "value": "*/*"
                                                  },
                                                  {
                                                    "description": "Added as a part of security scheme: oauth2",
                                                    "key": "Authorization",
                                                    "value": "<token>"
                                                  }
                                                ],
                                                "body": {
                                                  "mode": "raw",
                                                  "raw": "{\n  \"country\": \"<string>\",\n  \"currency\": \"<string>\",\n  \"language\": \"<string>\",\n  \"query\": \"<string>\",\n  \"page\": \"<integer>\",\n  \"perPage\": 30,\n  \"synonym\": {\n    \"action\": \"one-way\",\n    \"from\": [\n      \"<string>\"\n    ],\n    \"id\": \"<uuid>\",\n    \"to\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"locales\": [\n      {\n        \"language\": \"<string>\",\n        \"country\": \"<string>\",\n        \"currency\": \"<string>\"\n      },\n      {\n        \"language\": \"<string>\",\n        \"country\": \"<string>\",\n        \"currency\": \"<string>\"\n      }\n    ],\n    \"updatedAt\": \"<string>\"\n  },\n  \"debug\": \"<boolean>\",\n  \"additionalFields\": [\n    \"<string>\",\n    \"<string>\"\n  ]\n}",
                                                  "options": {
                                                    "raw": {
                                                      "headerFamily": "json",
                                                      "language": "json"
                                                    }
                                                  }
                                                },
                                                "url": {
                                                  "raw": "{{baseUrl}}/rest/organizations/:organizationId/commerce/v2/search/preview/synonyms/new?trackingId=<string>&id=<uuid>",
                                                  "host": [
                                                    "{{baseUrl}}"
                                                  ],
                                                  "path": [
                                                    "rest",
                                                    "organizations",
                                                    ":organizationId",
                                                    "commerce",
                                                    "v2",
                                                    "search",
                                                    "preview",
                                                    "synonyms",
                                                    "new"
                                                  ],
                                                  "query": [
                                                    {
                                                      "description": "(Required) The unique identifier of the tracking target.",
                                                      "key": "trackingId",
                                                      "value": "<string>"
                                                    },
                                                    {
                                                      "description": "A UUID identifying the synonym rule.",
                                                      "key": "id",
                                                      "value": "<uuid>"
                                                    }
                                                  ],
                                                  "variable": [
                                                    {
                                                      "key": "organizationId"
                                                    }
                                                  ]
                                                }
                                              },
                                              "status": "OK",
                                              "code": 200,
                                              "_postman_previewlanguage": "text",
                                              "header": [
                                                {
                                                  "key": "Content-Type",
                                                  "value": "*/*"
                                                }
                                              ],
                                              "cookie": [],
                                              "responseTime": null,
                                              "body": "{\n  \"products\": [\n    {\n      \"resultType\": \"<string>\",\n      \"additionalFields\": {\n        \"exercitation_d\": {}\n      },\n      \"queryPinned\": \"<boolean>\",\n      \"badgePlacements\": [\n        {\n          \"placementId\": \"<uuid>\",\n          \"badges\": [\n            {\n              \"text\": \"<string>\",\n              \"backgroundColor\": \"<string>\",\n              \"textColor\": \"<string>\",\n              \"iconUrl\": \"<string>\"\n            },\n            {\n              \"text\": \"<string>\",\n              \"backgroundColor\": \"<string>\",\n              \"textColor\": \"<string>\",\n              \"iconUrl\": \"<string>\"\n            }\n          ]\n        },\n        {\n          \"placementId\": \"<uuid>\",\n          \"badges\": [\n            {\n              \"text\": \"<string>\",\n              \"backgroundColor\": \"<string>\",\n              \"textColor\": \"<string>\",\n              \"iconUrl\": \"<string>\"\n            },\n            {\n              \"text\": \"<string>\",\n              \"backgroundColor\": \"<string>\",\n              \"textColor\": \"<string>\",\n              \"iconUrl\": \"<string>\"\n            }\n          ]\n        }\n      ],\n      \"ec_name\": \"<string>\",\n      \"ec_description\": \"<string>\",\n      \"ec_shortdesc\": \"<string>\",\n      \"ec_brand\": \"<string>\",\n      \"ec_category\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"ec_thumbnails\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"ec_images\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"ec_price\": \"<double>\",\n      \"ec_promo_price\": \"<double>\",\n      \"ec_in_stock\": \"<boolean>\",\n      \"ec_item_group_id\": \"<string>\",\n      \"ec_rating\": \"<double>\",\n      \"ec_product_id\": \"<string>\",\n      \"ec_gender\": \"<string>\",\n      \"ec_color\": \"<string>\",\n      \"ec_listing\": \"<string>\",\n      \"clickUri\": \"<string>\",\n      \"permanentid\": \"<string>\",\n      \"children\": [\n        {\n          \"resultType\": \"<string>\"\n        },\n        {\n          \"resultType\": \"<string>\"\n        }\n      ],\n      \"totalNumberOfChildren\": \"<integer>\",\n      \"score\": \"<integer>\",\n      \"scoreDifference\": \"<integer>\",\n      \"positionDifference\": \"<integer>\",\n      \"included\": \"<boolean>\",\n      \"pinned\": \"<boolean>\",\n      \"reservedPosition\": \"<boolean>\"\n    },\n    {\n      \"resultType\": \"<string>\",\n      \"additionalFields\": {\n        \"dolora\": {}\n      },\n      \"queryPinned\": \"<boolean>\",\n      \"badgePlacements\": [\n        {\n          \"placementId\": \"<uuid>\",\n          \"badges\": [\n            {\n              \"text\": \"<string>\",\n              \"backgroundColor\": \"<string>\",\n              \"textColor\": \"<string>\",\n              \"iconUrl\": \"<string>\"\n            },\n            {\n              \"text\": \"<string>\",\n              \"backgroundColor\": \"<string>\",\n              \"textColor\": \"<string>\",\n              \"iconUrl\": \"<string>\"\n            }\n          ]\n        },\n        {\n          \"placementId\": \"<uuid>\",\n          \"badges\": [\n            {\n              \"text\": \"<string>\",\n              \"backgroundColor\": \"<string>\",\n              \"textColor\": \"<string>\",\n              \"iconUrl\": \"<string>\"\n            },\n            {\n              \"text\": \"<string>\",\n              \"backgroundColor\": \"<string>\",\n              \"textColor\": \"<string>\",\n              \"iconUrl\": \"<string>\"\n            }\n          ]\n        }\n      ],\n      \"ec_name\": \"<string>\",\n      \"ec_description\": \"<string>\",\n      \"ec_shortdesc\": \"<string>\",\n      \"ec_brand\": \"<string>\",\n      \"ec_category\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"ec_thumbnails\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"ec_images\": [\n        \"<string>\",\n        \"<string>\"\n      ],\n      \"ec_price\": \"<double>\",\n      \"ec_promo_price\": \"<double>\",\n      \"ec_in_stock\": \"<boolean>\",\n      \"ec_item_group_id\": \"<string>\",\n      \"ec_rating\": \"<double>\",\n      \"ec_product_id\": \"<string>\",\n      \"ec_gender\": \"<string>\",\n      \"ec_color\": \"<string>\",\n      \"ec_listing\": \"<string>\",\n      \"clickUri\": \"<string>\",\n      \"permanentid\": \"<string>\",\n      \"children\": [\n        {\n          \"resultType\": \"<string>\"\n        },\n        {\n          \"resultType\": \"<string>\"\n        }\n      ],\n      \"totalNumberOfChildren\": \"<integer>\",\n      \"score\": \"<integer>\",\n      \"scoreDifference\": \"<integer>\",\n      \"positionDifference\": \"<integer>\",\n      \"included\": \"<boolean>\",\n      \"pinned\": \"<boolean>\",\n      \"reservedPosition\": \"<boolean>\"\n    }\n  ],\n  \"results\": [\n    {\n      \"resultType\": \"<string>\"\n    },\n    {\n      \"resultType\": \"<string>\"\n    }\n  ],\n  \"pagination\": {\n    \"page\": \"<integer>\",\n    \"perPage\": \"<integer>\",\n    \"totalEntries\": \"<integer>\",\n    \"totalPages\": \"<integer>\",\n    \"totalProducts\": \"<integer>\",\n    \"totalSpotlightContent\": \"<integer>\"\n  },\n  \"responseIds\": {\n    \"current\": \"<uuid>\",\n    \"modified\": \"<uuid>\"\n  },\n  \"executionReports\": {},\n  \"queryCorrection\": {\n    \"originalQuery\": \"<string>\",\n    \"correctedQuery\": \"<string>\",\n    \"corrections\": [\n      {\n        \"correctedQuery\": \"<string>\",\n        \"wordCorrections\": [\n          {\n            \"correctedWord\": \"<string>\",\n            \"length\": \"<integer>\",\n            \"offset\": \"<integer>\",\n            \"originalWord\": \"<string>\"\n          },\n          {\n            \"correctedWord\": \"<string>\",\n            \"length\": \"<integer>\",\n            \"offset\": \"<integer>\",\n            \"originalWord\": \"<string>\"\n          }\n        ]\n      },\n      {\n        \"correctedQuery\": \"<string>\",\n        \"wordCorrections\": [\n          {\n            \"correctedWord\": \"<string>\",\n            \"length\": \"<integer>\",\n            \"offset\": \"<integer>\",\n            \"originalWord\": \"<string>\"\n          },\n          {\n            \"correctedWord\": \"<string>\",\n            \"length\": \"<integer>\",\n            \"offset\": \"<integer>\",\n            \"originalWord\": \"<string>\"\n          }\n        ]\n      }\n    ]\n  }\n}",
                                              "createdAt": "2026-07-28T01:33:15.000Z",
                                              "updatedAt": "2026-07-28T01:33:15.000Z",
                                              "uid": "35240-ae4e7df3-d71f-4186-858c-08950b481018"
                                            }
                                          ],
                                          "createdAt": "2026-07-28T01:33:15.000Z",
                                          "updatedAt": "2026-07-28T01:33:15.000Z",
                                          "uid": "35240-5a6128c0-6a7d-4b25-a46a-e3956b1ba40f"
                                        }
                                      ],
                                      "id": "9f36e58d-ee37-4cb1-b46e-7728a01a205c",
                                      "createdAt": "2026-07-28T01:33:15.000Z",
                                      "updatedAt": "2026-07-28T01:33:15.000Z",
                                      "uid": "35240-9f36e58d-ee37-4cb1-b46e-7728a01a205c"
                                    }
                                  ],
                                  "id": "2f404471-ba77-4415-a149-c7a3905d71a1",
                                  "createdAt": "2026-07-28T01:33:15.000Z",
                                  "updatedAt": "2026-07-28T01:33:15.000Z",
                                  "uid": "35240-2f404471-ba77-4415-a149-c7a3905d71a1"
                                }
                              ],
                              "id": "a5c09206-a3cc-4b44-b6cd-ba3dd593c082",
                              "createdAt": "2026-07-28T01:33:15.000Z",
                              "updatedAt": "2026-07-28T01:33:15.000Z",
                              "uid": "35240-a5c09206-a3cc-4b44-b6cd-ba3dd593c082"
                            }
                          ],
                          "id": "a73a1708-3386-43e8-97f1-fb7241b649a2",
                          "createdAt": "2026-07-28T01:33:15.000Z",
                          "updatedAt": "2026-07-28T01:33:15.000Z",
                          "uid": "35240-a73a1708-3386-43e8-97f1-fb7241b649a2"
                        }
                      ],
                      "id": "198803a7-941a-4c55-ac25-eac1919ab243",
                      "createdAt": "2026-07-28T01:33:15.000Z",
                      "updatedAt": "2026-07-28T01:33:15.000Z",
                      "uid": "35240-198803a7-941a-4c55-ac25-eac1919ab243"
                    }
                  ],
                  "id": "bad8bf57-81d6-4718-af71-e186edc26198",
                  "createdAt": "2026-07-28T01:33:15.000Z",
                  "updatedAt": "2026-07-28T01:33:15.000Z",
                  "uid": "35240-bad8bf57-81d6-4718-af71-e186edc26198"
                }
              ],
              "id": "bd76b5f5-b165-475a-bc71-f35c81878f68",
              "createdAt": "2026-07-28T01:33:15.000Z",
              "updatedAt": "2026-07-28T01:33:15.000Z",
              "uid": "35240-bd76b5f5-b165-475a-bc71-f35c81878f68"
            }
          ],
          "id": "aa0ceba5-7992-4458-b263-9bf784fce73f",
          "createdAt": "2026-07-28T01:33:15.000Z",
          "updatedAt": "2026-07-28T01:33:15.000Z",
          "uid": "35240-aa0ceba5-7992-4458-b263-9bf784fce73f"
        }
      ],
      "id": "14807a6f-3395-4613-9aae-f1a4bed2b40c",
      "createdAt": "2026-07-28T01:33:15.000Z",
      "updatedAt": "2026-07-28T01:33:15.000Z",
      "uid": "35240-14807a6f-3395-4613-9aae-f1a4bed2b40c"
    }
  ],
  "auth": {
    "type": "oauth2",
    "oauth2": [
      {
        "key": "scope",
        "value": "full",
        "type": "string"
      },
      {
        "key": "accessTokenUrl",
        "value": "https://platform.cloud.coveo.com/oauth/token",
        "type": "string"
      },
      {
        "key": "authUrl",
        "value": "https://platform.cloud.coveo.com/oauth/authorize",
        "type": "string"
      },
      {
        "key": "grant_type",
        "value": "authorization_code",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://platform.cloud.coveo.com"
    }
  ]
}