{
    "swagger": "2.0",
    "info": {
        "description": "A tool that provides a sorted list of the relevent keywords and their traffic statistics based on the multiple search types and conditions as query parameters.\n",
        "version": "Alpha",
        "title": "KeywordsTool",
        "contact": {
            "name": "yeseul.park@navercorp.com"
        }
    },
    "paths": {
        "/keywordstool": {
            "get": {
                "tags": [
                    "RelKwdStat"
                ],
                "summary": "list",
                "description": "Retrieves related keywords and their statistical indicators by query parameters. To determine search types and conditions, a user requests data by combining at least one parameter among `business ID`, `ncc business channel ID`, `keyword hints`, `season`, `event ID` and by using several conditional parameters.    \n",
                "parameters": [
                    {
                        "name": "siteId",
                        "in": "query",
                        "description": "Buisness chanel ID(nccBusinessChannelId) restricted for site channel type (channelTp= “SITE”)",
                        "required": false,
                        "type": "string"
                    },
                    {
                        "name": "biztpId",
                        "in": "query",
                        "description": "Business type id",
                        "required": false,
                        "type": "integer"
                    },
                    {
                        "name": "hintKeywords",
                        "in": "query",
                        "description": "Keyword list for hint. The list delimiter is comma (e.g. 꽃배달,flower,화환,bouquet), up to 5 keywords could be listed.",
                        "required": false,
                        "type": "string"
                    },
                    {
                        "name": "event",
                        "in": "query",
                        "description": "Seasonal theme",
                        "required": false,
                        "type": "integer",
                        "example":"[gist:\"235202ffb08f9433b6f7cb10e45875f7\"]"
                    },
                    {
                        "name": "month",
                        "in": "query",
                        "description": "Month (e.g. 12)",
                        "required": false,
                        "type": "integer"
                    },
                    {
                        "name": "showDetail",
                        "in": "query",
                        "description": "Set `showDetail` = 1 to fetch detailed statistic information per each related keyword (query count, click count, CTR, competitiveness index, depth) as well as relavent keywords list. For fetching related keywords and monthly query count info only, set `showDetail` = 0.",
                        "required": false,
                        "type": "integer"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Successful response",
                        "schema": {
                            "title": "keywordList",
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/RelKwdStat"
                            }
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "RelKwdStat": {
            "type": "object",
            "properties": {
                "relKeyword": {
                    "type": "string",
                    "description": "A related keyword"
                },
                "monthlyPcQcCnt": {
                    "type": "string",
                    "description": "Sum of PC query counts in recent 30 days. If the query count is less than 10, you get \"<10\"."
                },
                "monthlyMobileQcCnt": {
                    "type": "string",
                    "description": "Sum of Mobile query counts in recent 30 days. If the query count is less than 10, you get \"<10\"."
                },
                "monthlyAvePcClkCnt": {
                    "type": "string",
                    "description": "Average PC click counts per keyword's ad in recent 4 weeks. With no data, you get 0."
                },
                "monthlyAveMobileClkCnt": {
                    "type": "string",
                    "description": "Average Mobile click counts per keyword's ad in recent 4 weeks. With no data, you get 0."
                },
                "monthlyAvePcCtr": {
                    "type": "string",
                    "description": "Click-through rate of PC in recent 4 weeks. With no data, you get 0."
                },
                "monthlyAveMobileCtr": {
                    "type": "string",
                    "description": "Click-through rate of Mobile in recent 4 weeks. With no data, you get 0."
                },
                "plAvgDepth": {
                    "type": "string",
                    "description": "Average depth of PC ad in recent 4 weeks. With no data, you get 0."
                },
                "compIdx": {
                    "type": "string",
                    "description": "A competitiveness index based on PC ad. low: low competitiveness, mid: middle competitiveness, high: high competitiveness"
                }
            }
        }
    }
}