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

This endpoint has no request body.

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

This endpoint has no request body.

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