English

search

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in Classic and VPC

Provide statistics of NAVER Unified Search's trend data by period for a group of topic keywords, analyzed by age, gender, and search environment in JSON format.

Note

It is identical to the Search keyword trend search results in NAVER DataLab.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
POST	/search

Request headers

For headers common to all Search Trend APIs, see Common Search Trend headers.

Request body

The following describes the request body.

Field	Type	Required	Description
`startDate`	String	Required	Data query start date (yyyy-MM-dd) Retrievable from January 1, 2016
`endDate`	String	Required	Data query end date (yyyy-MM-dd)
`timeUnit`	String	Required	Data query section unit `date` \| `week` \| `month` `date`: Get daily data `week`: Get weekly data `month`: Get monthly data
`keywordGroups`	Array<String>	Required	Topic keyword, search keyword group information Support for up to 5 groups simultaneously
`device`	String	Optional	Search device environment filter `pc` \| `mo` `pc`: PC environment `mo`: Mobile environment
`ages`	Array<String>	Optional	Age filter `1` \| `2` \| `3` \| `4` \| `5` \| `6` \| `7` \| `8` \| `9` \| `10` \| `11` `1`: 0 - 12 `2`: 13 - 18 `3`: 19 - 24 `4`: 25 - 29 `5`: 30 - 34 `6`: 35 - 39 `7`: 40 - 44 `8`: 45 - 49 `9`: 50 - 54 `10`: 55 - 59 `11`: 60 or older
`gender`	String	Optional	Gender filter `m` \| `f` `m`: male `f`: female

`keywordGroups`

The following describes keywordGroups.

Field	Type	Required	Description
`groupName`	String	Required	Group name (topic keyword) Consolidate data into groups by grouping search keywords together to query data for
`keywords`	String	Required	Search keyword list for a group Support for up to 20 search keywords per data group

Request example

The following is a sample request.

curl --location --request POST 'https://naveropenapi.apigw.ntruss.com/datalab/v1/search' \
--header 'X-NCP-APIGW-API-KEY-ID: {Client ID issued when registering the app}' \
--header 'X-NCP-APIGW-API-KEY: {Client secret issued when registering the app}' \
--header 'Content-Type: application/json' \
--data '{
    "startDate": "2024-08-15",
    "endDate": "2024-08-19",
    "timeUnit": "date",
    "keywordGroups": [
        {
            "groupName": "Maratang",
            "keywords": [
                "Maratang",
                "Guo bao rou",
                "Egg fried rice"
            ]
        }
    ],    
    "device": "mo",
    "ages": [
        "4",
        "5"
    ],
    "gender": "f"
}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`startDate`	String	-	Data query start date (yyyy-MM-dd) Retrievable from January 1, 2016
`endDate`	String	-	Data query end date (yyyy-MM-dd)
`timeUnit`	String	-	Data query section unit `date` \| `week` \| `month` `date`: Get daily data `week`: Get weekly data `month`: Get monthly data
`results`	Array	-	Group information

`results`

The following describes results.

Field	Type	Required	Description
`title`	String	-	Group name (topic keyword)
`keywords`	String	-	Group search keyword list
`data`	Array	-	Information by section

`data`

The following describes data.

Field	Type	Required	Description
`period`	String	-	Start date by data query section (yyyy-MM-dd)
`ratio`	Integer	-	Search/click ratio by data query section Set the largest of the resulting values to 100

Response status codes

For response status codes common to all Search Trend APIs, see Common Search Trend response status codes.

Response example

The following is a sample example.

{
    "startDate": "2024-08-15",
    "endDate": "2024-08-19",
    "timeUnit": "date",
    "results": [
        {
            "title": "Maratang",
            "keywords": [
                "Maratang",
                "Guo bao rou",
                "Egg fried rice"
            ],
            "data": [
                {
                    "period": "2024-08-15",
                    "ratio": 100
                },
                {
                    "period": "2024-08-16",
                    "ratio": 84.81543
                },
                {
                    "period": "2024-08-17",
                    "ratio": 88.33892
                },
                {
                    "period": "2024-08-18",
                    "ratio": 97.31543
                }
            ]
        }
    ]
}

Was this article helpful?

What's Next

Search Trend examples

Table of contents

Request
Response