v10 - Insights - Demo Endpoints

Get product rank for 8710103972136 using BROWSE

It gives the list of ranks for ean 8710103972136 using search type of BROWSE for a given date.

GET /retailer-demo/insights/product-ranks?ean=8710103972136&date=2025-05-09&type=BROWSE

Request
Response

Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)
Accept-Language: nl-NL

This endpoint has no request body.

Content-Type: application/vnd.retailer.v10+json

Status: 200 OK

{
  "ranks" : [ {
    "categoryId" : "18336",
    "wasSponsored" : false,
    "rank" : 43,
    "impressions" : 130
  } ],
  "hasNextPage" : false
}

Get product rank for 7613037048292

It gives the list of ranks for ean 7613037048292 for a given date.

GET /retailer-demo/insights/product-ranks?ean=7613037048292&date=2025-05-09

Request
Response

Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)
Accept-Language: nl-NL

This endpoint has no request body.

Content-Type: application/vnd.retailer.v10+json

Status: 200 OK

{
  "ranks" : [ {
    "categoryId" : "30271",
    "wasSponsored" : false,
    "rank" : 56,
    "impressions" : 21
  }, {
    "searchTerm" : "nespresso capsules",
    "wasSponsored" : false,
    "rank" : 34,
    "impressions" : 6
  }, {
    "searchTerm" : "starbucks",
    "wasSponsored" : false,
    "rank" : 18,
    "impressions" : 34
  }, {
    "searchTerm" : "starbucks nespresso",
    "wasSponsored" : false,
    "rank" : 4,
    "impressions" : 32
  } ],
  "hasNextPage" : false
}

Get product rank for 8004399027190 using SEARCH

It gives the list of ranks for ean 8004399027190 using search type of SEARCH for a given date.

GET /retailer-demo/insights/product-ranks?ean=8710103972136&date=2025-05-09&type=SEARCH

Request
Response

Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)
Accept-Language: nl-NL

This endpoint has no request body.

Content-Type: application/vnd.retailer.v10+json

Status: 200 OK

{
  "ranks" : [ {
    "searchTerm" : "delonghi pistonmachine",
    "wasSponsored" : false,
    "rank" : 9,
    "impressions" : 9
  } ],
  "hasNextPage" : false
}

Get performance indicator list by week, year and type

Get performance indicator list by week, year and type.

GET /retailer-demo/insights/performance/indicator?week=10&year=2019&name=CANCELLATIONS,FULFILMENT,PHONE_AVAILABILITY,CASE_ITEM_RATIO,TRACK_AND_TRACE,RETURNS,REVIEWS

Request
Response

Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v10+json

Status: 200 OK

{
  "performanceIndicators" : [ {
    "name" : "CANCELLATIONS",
    "type" : "PERCENTAGE",
    "details" : {
      "period" : {
        "week" : "10",
        "year" : "2019"
      },
      "score" : {
        "conforms" : false,
        "numerator" : 8,
        "denominator" : 88,
        "value" : 0.88,
        "distanceToNorm" : 0.86
      },
      "norm" : {
        "condition" : "&lt;=",
        "value" : 0.02
      }
    }
  }, {
    "name" : "PHONE_AVAILABILITY",
    "type" : "PERCENTAGE",
    "details" : {
      "period" : {
        "week" : "10",
        "year" : "2019"
      },
      "norm" : {
        "condition" : "&gt;=",
        "value" : 0.9
      }
    }
  }, {
    "name" : "REVIEWS",
    "type" : "AVERAGE",
    "details" : {
      "period" : {
        "week" : "10",
        "year" : "2019"
      },
      "norm" : {
        "condition" : "&gt;=",
        "value" : 8.0
      }
    }
  }, {
    "name" : "CASE_ITEM_RATIO",
    "type" : "PERCENTAGE",
    "details" : {
      "period" : {
        "week" : "10",
        "year" : "2019"
      },
      "score" : {
        "conforms" : true,
        "numerator" : 0,
        "denominator" : 54,
        "value" : 0.0,
        "distanceToNorm" : 0.05
      },
      "norm" : {
        "condition" : "&lt;=",
        "value" : 0.05
      }
    }
  }, {
    "name" : "RETURNS",
    "type" : "PERCENTAGE",
    "details" : {
      "period" : {
        "week" : "10",
        "year" : "2019"
      },
      "norm" : {
        "condition" : "&lt;=",
        "value" : 0.05
      }
    }
  }, {
    "name" : "TRACK_AND_TRACE",
    "type" : "PERCENTAGE",
    "details" : {
      "period" : {
        "week" : "10",
        "year" : "2019"
      },
      "norm" : {
        "condition" : "&gt;=",
        "value" : 1.0
      }
    }
  }, {
    "name" : "FULFILMENT",
    "type" : "PERCENTAGE",
    "details" : {
      "period" : {
        "week" : "10",
        "year" : "2019"
      },
      "norm" : {
        "condition" : "&gt;=",
        "value" : 0.93
      }
    }
  } ]
}

Get performance indicator by week, year and type

Get performance indicator by week, year and type.

GET /retailer-demo/insights/performance/indicator?week=10&year=2019&name=CANCELLATIONS

Request
Response

Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v10+json

Status: 200 OK

{
  "performanceIndicators" : [ {
    "name" : "CANCELLATIONS",
    "type" : "PERCENTAGE",
    "details" : {
      "period" : {
        "week" : "10",
        "year" : "2019"
      },
      "score" : {
        "conforms" : false,
        "numerator" : 8,
        "denominator" : 88,
        "value" : 0.88,
        "distanceToNorm" : 0.86
      },
      "norm" : {
        "condition" : "&lt;=",
        "value" : 0.02
      }
    }
  } ]
}

Get offer insights for period MONTH.

Get the offer insights for an offer id and receiving the number of customer visits on the product page and percentage of time that your offer had the buy box for the country code over the requested period.

GET /retailer-demo/insights/offer?offer-id=7aec42a4-8c2b-4c38-ac3c-5e5a3f54341e&period=MONTH&number-of-periods=1&name=PRODUCT_VISITS&name=BUY_BOX_PERCENTAGE

Request
Response

Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v10+json

Status: 200 OK

{
  "offerInsights" : [ {
    "name" : "BUY_BOX_PERCENTAGE",
    "type" : "percentage",
    "countries" : [ {
      "countryCode" : "BE",
      "value" : 100.0
    }, {
      "countryCode" : "NL",
      "value" : 92.9
    } ],
    "periods" : [ {
      "period" : {
        "month" : 12,
        "year" : 2019
      },
      "countries" : [ {
        "countryCode" : "BE",
        "value" : 100.0
      }, {
        "countryCode" : "NL",
        "value" : 92.9
      } ]
    } ]
  }, {
    "name" : "PRODUCT_VISITS",
    "type" : "count",
    "total" : 72.0,
    "countries" : [ {
      "countryCode" : "BE",
      "value" : 7.0
    }, {
      "countryCode" : "NL",
      "value" : 65.0
    } ],
    "periods" : [ {
      "period" : {
        "month" : 12,
        "year" : 2019
      },
      "total" : 72.0,
      "countries" : [ {
        "countryCode" : "BE",
        "value" : 7.0
      }, {
        "countryCode" : "NL",
        "value" : 65.0
      } ]
    } ]
  } ]
}

Get offer insights for period WEEK.

GET /retailer-demo/insights/offer?offer-id=4db52074-7269-4b36-a7e1-e9227a9c0f9b&period=WEEK&number-of-periods=1&name=PRODUCT_VISITS

Request
Response

Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v10+json

Status: 200 OK

{
  "offerInsights" : [ {
    "name" : "PRODUCT_VISITS",
    "type" : "count",
    "total" : 4.0,
    "countries" : [ {
      "countryCode" : "BE",
      "value" : 4.0
    } ],
    "periods" : [ {
      "period" : {
        "week" : 49,
        "year" : 2019
      },
      "total" : 4.0,
      "countries" : [ {
        "countryCode" : "BE",
        "value" : 4.0
      } ]
    } ]
  } ]
}

Get offer insights for period DAY.

GET /retailer-demo/insights/offer?offer-id=81c28f60-ed1d-4b85-e053-828b620a4ed5&period=DAY&number-of-periods=1&name=BUY_BOX_PERCENTAGE

Request
Response

Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v10+json

Status: 200 OK

{
  "offerInsights" : [ {
    "name" : "BUY_BOX_PERCENTAGE",
    "type" : "percentage",
    "countries" : [ {
      "countryCode" : "NL",
      "value" : 100.0
    } ],
    "periods" : [ {
      "period" : {
        "day" : 5,
        "month" : 12,
        "year" : 2019
      },
      "countries" : [ {
        "countryCode" : "NL",
        "value" : 100.0
      } ]
    } ]
  } ]
}

Get sales forecast range by offer id 91c28f60-ed1d-4b85-e053-828b620a4ed5

Get the sales forecast by offer id up to 3 weeks from now. This example shows a forecast using a range (the case when you did not sold at least 2 items within the last 28 days).

GET /retailer-demo/insights/sales-forecast?offer-id=91c28f60-ed1d-4b85-e053-828b620a4ed5&weeks-ahead=12

Request
Response

Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v10+json

Status: 200 OK

{
  "name" : "SALES_FORECAST",
  "type" : "decimal",
  "total" : {
    "minimum" : 10.0,
    "maximum" : 100.0
  },
  "countries" : [ {
    "countryCode" : "BE",
    "minimum" : 0.0,
    "maximum" : 10.0
  }, {
    "countryCode" : "NL",
    "minimum" : 10.0,
    "maximum" : 100.0
  } ],
  "periods" : [ {
    "weeksAhead" : 1,
    "total" : {
      "minimum" : 0.0,
      "maximum" : 10.0
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 10.0
    }, {
      "countryCode" : "NL",
      "minimum" : 0.0,
      "maximum" : 10.0
    } ]
  }, {
    "weeksAhead" : 2,
    "total" : {
      "minimum" : 0.0,
      "maximum" : 10.0
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 10.0
    }, {
      "countryCode" : "NL",
      "minimum" : 0.0,
      "maximum" : 10.0
    } ]
  }, {
    "weeksAhead" : 3,
    "total" : {
      "minimum" : 0.0,
      "maximum" : 10.0
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 10.0
    }, {
      "countryCode" : "NL",
      "minimum" : 0.0,
      "maximum" : 10.0
    } ]
  }, {
    "weeksAhead" : 4,
    "total" : {
      "minimum" : 0.0,
      "maximum" : 10.0
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 10.0
    }, {
      "countryCode" : "NL",
      "minimum" : 0.0,
      "maximum" : 10.0
    } ]
  }, {
    "weeksAhead" : 5,
    "total" : {
      "minimum" : 0.0,
      "maximum" : 10.0
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 10.0
    }, {
      "countryCode" : "NL",
      "minimum" : 0.0,
      "maximum" : 10.0
    } ]
  }, {
    "weeksAhead" : 6,
    "total" : {
      "minimum" : 0.0,
      "maximum" : 10.0
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 10.0
    }, {
      "countryCode" : "NL",
      "minimum" : 0.0,
      "maximum" : 10.0
    } ]
  }, {
    "weeksAhead" : 7,
    "total" : {
      "minimum" : 0.0,
      "maximum" : 10.0
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 10.0
    }, {
      "countryCode" : "NL",
      "minimum" : 0.0,
      "maximum" : 10.0
    } ]
  }, {
    "weeksAhead" : 8,
    "total" : {
      "minimum" : 0.0,
      "maximum" : 10.0
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 10.0
    }, {
      "countryCode" : "NL",
      "minimum" : 0.0,
      "maximum" : 10.0
    } ]
  }, {
    "weeksAhead" : 9,
    "total" : {
      "minimum" : 0.0,
      "maximum" : 10.0
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 10.0
    }, {
      "countryCode" : "NL",
      "minimum" : 0.0,
      "maximum" : 10.0
    } ]
  }, {
    "weeksAhead" : 10,
    "total" : {
      "minimum" : 0.0,
      "maximum" : 10.0
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 10.0
    }, {
      "countryCode" : "NL",
      "minimum" : 0.0,
      "maximum" : 10.0
    } ]
  }, {
    "weeksAhead" : 11,
    "total" : {
      "minimum" : 0.0,
      "maximum" : 10.0
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 10.0
    }, {
      "countryCode" : "NL",
      "minimum" : 0.0,
      "maximum" : 10.0
    } ]
  }, {
    "weeksAhead" : 12,
    "total" : {
      "minimum" : 0.0,
      "maximum" : 10.0
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 10.0
    }, {
      "countryCode" : "NL",
      "minimum" : 0.0,
      "maximum" : 10.0
    } ]
  } ]
}

Get sales forecast by offer id 81c28f60-ed1d-4b85-e053-828b620a4ed5

Get the sales forecast by offer id up to 3 weeks from now. This example shows an exact forecast (the case when you sold at least 2 items within the last 28 days).

GET /retailer-demo/insights/sales-forecast?offer-id=81c28f60-ed1d-4b85-e053-828b620a4ed5&weeks-ahead=3

Request
Response

Accept: application/vnd.retailer.v10+json
Content-Type: None
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v10+json

Status: 200 OK

{
  "name" : "SALES_FORECAST",
  "type" : "decimal",
  "total" : {
    "minimum" : 42.3,
    "maximum" : 42.3
  },
  "countries" : [ {
    "countryCode" : "BE",
    "minimum" : 0.0,
    "maximum" : 0.0
  }, {
    "countryCode" : "NL",
    "minimum" : 42.3,
    "maximum" : 42.3
  } ],
  "periods" : [ {
    "weeksAhead" : 1,
    "total" : {
      "minimum" : 11.4,
      "maximum" : 11.4
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 0.0
    }, {
      "countryCode" : "NL",
      "minimum" : 11.4,
      "maximum" : 11.4
    } ]
  }, {
    "weeksAhead" : 2,
    "total" : {
      "minimum" : 13.1,
      "maximum" : 13.1
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 0.0
    }, {
      "countryCode" : "NL",
      "minimum" : 13.1,
      "maximum" : 13.1
    } ]
  }, {
    "weeksAhead" : 3,
    "total" : {
      "minimum" : 17.8,
      "maximum" : 17.8
    },
    "countries" : [ {
      "countryCode" : "BE",
      "minimum" : 0.0,
      "maximum" : 0.0
    }, {
      "countryCode" : "NL",
      "minimum" : 17.8,
      "maximum" : 17.8
    } ]
  } ]
}

Retrieve search term excluding related information for term: 'Mondkapje'.

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.v10+json
Content-Type: None
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v10+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
      } ]
    } ]
  }
}

Retrieve search term and related information for term: 'Mondkapje'

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.v10+json
Content-Type: None
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v10+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"
    } ]
  }
}