v5 - Insights - Demo Endpoints

Retrieves search term information, excluding related information (for speed), using search term 'Mondkapje'.

GET /retailer-demo/insights/search-terms?search-term=Mondkapje&period=WEEK&number-of-periods=2&related-search-terms=false

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v5+json
Status: 200 OK

{
  "searchTerms" : {
    "searchTerm" : "Mondkapje",
    "type" : "count",
    "total" : 8329,
    "countries" : [ {
      "countryCode" : "NL",
      "value" : 7200
    }, {
      "countryCode" : "BE",
      "value" : 1129
    } ],
    "periods" : [ {
      "period" : {
        "week" : "44",
        "year" : "2020"
      },
      "total" : 4248,
      "countries" : [ {
        "countryCode" : "NL",
        "value" : 3657
      }, {
        "countryCode" : "BE",
        "value" : 591
      } ]
    }, {
      "period" : {
        "week" : "45",
        "year" : "2020"
      },
      "total" : 4081,
      "countries" : [ {
        "countryCode" : "NL",
        "value" : 3543
      }, {
        "countryCode" : "BE",
        "value" : 538
      } ]
    } ]
  }
}

Retrieves search term information, including related information, using search term 'Mondkapje'.

GET /retailer-demo/insights/search-terms?search-term=Mondkapje&period=WEEK&number-of-periods=2&related-search-terms=true

  • Request

  • Response

Accept: application/vnd.retailer.v5+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v5+json
Status: 200 OK

{
  "searchTerms" : {
    "searchTerm" : "Mondkapje",
    "type" : "count",
    "total" : 8329,
    "countries" : [ {
      "countryCode" : "NL",
      "value" : 7200
    }, {
      "countryCode" : "BE",
      "value" : 1129
    } ],
    "periods" : [ {
      "period" : {
        "week" : "44",
        "year" : "2020"
      },
      "total" : 4248,
      "countries" : [ {
        "countryCode" : "NL",
        "value" : 3657
      }, {
        "countryCode" : "BE",
        "value" : 591
      } ]
    }, {
      "period" : {
        "week" : "45",
        "year" : "2020"
      },
      "total" : 4081,
      "countries" : [ {
        "countryCode" : "NL",
        "value" : 3543
      }, {
        "countryCode" : "BE",
        "value" : 538
      } ]
    } ],
    "relatedSearchTerms" : [ {
      "total" : 4220,
      "searchTerm" : "mondkapje wasbaar"
    }, {
      "total" : 4123,
      "searchTerm" : "mondmasker"
    }, {
      "total" : 1788,
      "searchTerm" : "mondkapjes"
    }, {
      "total" : 963,
      "searchTerm" : "mondkapjes 50 stuks"
    }, {
      "total" : 815,
      "searchTerm" : "mondkapje zwart"
    }, {
      "total" : 800,
      "searchTerm" : "mondkapjes medisch"
    }, {
      "total" : 774,
      "searchTerm" : "mondkapje brildrager"
    }, {
      "total" : 208,
      "searchTerm" : "mondkapje adidas"
    }, {
      "total" : 195,
      "searchTerm" : "mondkapje wasbaar met filter"
    }, {
      "total" : 173,
      "searchTerm" : "mondkapje katoen"
    } ]
  }
}