Sample Response

{
    "success": true,
    "message": "",
    "errorCode": "",
    "result": {
        "data": [
            {
                "brand": "anmum",
                "merchant": "shopee",
                "keyword": "maternal milk",
                "channel": "web",
                "share": "20.00",
                "tags": [
                    "category"
                ],
                "searchDetails": [
                    {
                        "productTitle": "Enfamama A+ Maternal & Lactating Milk Formula (600g)",
                        "productCode": "",
                        "merchantProductId": "3727586799",
                        "productUrl": "",
                        "brand": "enfamama",
                        "skuIds": [
                            "60073857227"
                        ],
                        "type": "organic",
                        "rank": 1
                    },
                    {
                        "productTitle": "Enfamama A+ Maternal & Lactating Formula 50g",
                        "productCode": "",
                        "merchantProductId": "2162170523",
                        "productUrl": "",
                        "brand": "enfamama",
                        "skuIds": [
                            "4693710249",
                            "4693710250"
                        ],
                        "type": "organic",
                        "rank": 2
                    },
                    {
                        "productTitle": "Promama Maternal Nutrition 600g",
                        "productCode": "",
                        "merchantProductId": "961318537",
                        "productUrl": "",
                        "brand": "wyeth",
                        "skuIds": [
                            "961318537"
                        ],
                        "type": "organic",
                        "rank": 3
                    },
                    {
                        "productTitle": "Enfamama A+ Chocolate - 900g",
                        "productCode": "",
                        "merchantProductId": "7780243155",
                        "productUrl": "",
                        "brand": "enfamama",
                        "skuIds": [],
                        "type": "organic",
                        "rank": 4
                    },
                    {
                        "productTitle": "Anmum Materna (650g)",
                        "productCode": "",
                        "merchantProductId": "1839109288",
                        "productUrl": "",
                        "brand": "anmum",
                        "skuIds": [
                            "3152335775"
                        ],
                        "type": "organic",
                        "rank": 5
                    }
                ]
            }
        ],
        "total": 1,
        "totalSearchResults": 5,
        "type": "shareOfSearch",
        "date": "2021-05-02"
    }
}

Response Fields

Field	Description	Data Type
success	Indicates if API response is success or not.	bool
message	Response message. Typically populated in error scenarios.	string
errorCode	Error code.	string
brand	Brand name.	string
merchant	Merchant name.	string
keyword	Search keyword.	string
share	Brand share percentage in the search results.	number
tags	Keyword group tag.	list
channel	Web or App.	string
searchDetails	Search results.	list
total	Total number of keywords.	number
totalSearchResults	Total number of search results.	number
date	Date.	string

Exceptions and Error Conditions

The Share of Search API will look for matching data based on the filters applied. However, there are a few scenarios where the API may not be able to return a valid response. For example

Data request for a future date.
Data requested for invalid merchant/brand combination.
Data request for the invalid channel.
Invalid API key.

In all the above scenarios, the Share of Search API would return with an error response.
Example:

{
  "success": false,
  "message": "You can not request for future date",
  "errorCode": "INVALID_DATE",
  "result": ""
}

200Successful response