v4 - Insights - Demo Endpoints

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.v4+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v4+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" : "<=",
        "value" : 0.02
      }
    }
  }, {
    "name" : "PHONE_AVAILABILITY",
    "type" : "PERCENTAGE",
    "details" : {
      "period" : {
        "week" : "10",
        "year" : "2019"
      },
      "norm" : {
        "condition" : ">=",
        "value" : 0.9
      }
    }
  }, {
    "name" : "REVIEWS",
    "type" : "AVERAGE",
    "details" : {
      "period" : {
        "week" : "10",
        "year" : "2019"
      },
      "norm" : {
        "condition" : ">=",
        "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" : "<=",
        "value" : 0.05
      }
    }
  }, {
    "name" : "RETURNS",
    "type" : "PERCENTAGE",
    "details" : {
      "period" : {
        "week" : "10",
        "year" : "2019"
      },
      "norm" : {
        "condition" : "<=",
        "value" : 0.05
      }
    }
  }, {
    "name" : "TRACK_AND_TRACE",
    "type" : "PERCENTAGE",
    "details" : {
      "period" : {
        "week" : "10",
        "year" : "2019"
      },
      "norm" : {
        "condition" : ">=",
        "value" : 1.0
      }
    }
  }, {
    "name" : "FULFILMENT",
    "type" : "PERCENTAGE",
    "details" : {
      "period" : {
        "week" : "10",
        "year" : "2019"
      },
      "norm" : {
        "condition" : ">=",
        "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.v4+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v4+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" : "<=",
        "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.v4+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v4+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 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=4db52074-7269-4b36-a7e1-e9227a9c0f9b&period=WEEK&number-of-periods=1&name=PRODUCT_VISITS

  • Request

  • Response

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

This endpoint has no request body.

Content-Type: application/vnd.retailer.v4+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 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=81c28f60-ed1d-4b85-e053-828b620a4ed5&period=DAY&number-of-periods=1&name=BUY_BOX_PERCENTAGE

  • Request

  • Response

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

This endpoint has no request body.

Content-Type: application/vnd.retailer.v4+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.v4+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

Content-Type: application/vnd.retailer.v4+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.v4+json
Content-Type: N/A
Authorization: Bearer token (omitted)

This endpoint has no request body.

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