List keywords

Keywords provides a list of the top keywords ( up to 1,000) searched on for a specific catalog. The keywords are only specific to that catalog, and not system wide. The keywords are also only reported for the past 30 days.

Request URL

[GET] http://api.popshops.com/v3/keywords.xml
[GET] http://api.popshops.com/v3/keywords.json

Response Formats

XML, JSON

Required request parameters

Parameter name Type Kind Allowed values Default value Description
account account Your API account key. You can find this on your API keys account page.
catalog account A catalog key to limit the keywords to those for a specific catalog.

Optional request parameters

None.

Response results

Node Attribute Kind Data Type Description
keywords The container for all individual keywords.
keyword An individual keyword.
phraserequired string The keyword phrase
count count integer The number of times the keyword has been searched for the past 30 days.

Resources

None

Sample response


<?xml version="1.0" encoding="UTF-8"?>
<response status="200" message="ok">
  <parameters>
    <parameter kind="account" value="d1lg0my9c6y3j5iv5vkc6ayrd" name="account"></parameter>
    <parameter name="catalog" value="dp4rtmme6tbhugpv6i59yiqmr" type="item"></parameter>
  </parameters>
  <results>
    <keywords count="575">
      <keyword phrase="red roses" count="17943"></keyword>
      <keyword phrase="artificial christmas trees" count="5934"></keyword>
      <keyword phrase="ipod" count="1199"></keyword>
      <keyword phrase="shoes" count="13"></keyword>
      <keyword phrase="iphone" count="12"></keyword>
      <keyword phrase="flowers" count="11"></keyword>
      <keyword phrase="chairs" count="10"></keyword>
      ...
    </keywords>
  </results>
</response>

{
   "results":
   {
       "keywords":
       {
           "count": 575,
           "keyword":
           [
               {
                   "phrase": "red roses",
                   "count": 17943
               },
              {
                  "phrase": "9 artificial christmas trees",
                  "count": 5934
              },
              {
                  "phrase": "ipod",
                  "count": 1199
              },
             {
                 "phrase": "shoes",
                 "count": 13
              },
             {
                  "phrase": "iphone",
                  "count": 12
              },
              {
                  "phrase": "flowers",
                  "count": 11
               },
               ...
           ]
       }
   },
   "status": 200,
   "parameters":
   [
       {
           "kind": "account",
           "value": "d1lg0my9c6y3j5iv5vkc6ayrd",
           "name": "account"
       },
       {
           "name": "catalog",
            "value": "dp4rtmme6tbhugpv6i59yiqmr",
            "type": "item"
        }
   ],
   "message": "ok"
}