Skip to main content

Overview Module

The Overview module exposes endpoints for querying overview data.

Enterprise Companies#

This endpoint shows overview data for a particular enterprise's companies.

GET /overview/enterprise/:slug/companies

Parameters#

  • slugrequired

    The requested enterprise entity's slug.

  • date_startrequiredformat: YYYY-MM-DD

    Start date for queried dataset.

  • date_endrequiredformat: YYYY-MM-DD

    End date for queried dataset.

  • page_sizeoptionaldefault: 10

    Number of results to return in response. Pass -1 for all results.

  • pageoptionaldefault: 1

    If returning paginated results, the page of results to return.

  • orderoptionaldefault: DESCoptions: DESC, ASC

    Ordering of response based on revenue key.

Returns#

Returns an array of companies with structured overview data over the defined time period.

Example Call#

/overview/enterprise/zquared/companies?date_start=2019-05-01&date_end=2019-05-15

RESPONSE

[
{
"name": "ZQUARED",
"slug": "zquared",
"financials": {
"revenue": 1485, // sum of channels' values
"sales": 33, // sum of channels' values
"previous_period_sales": 20, // previous date range (i.e. if current is May 1-15, prev is Apr 15-30)
"return": 0.013, // Return Quantity / Sale Quantity; average of channels' values
"channels": [
{
"channel": "Amazon.com",
"revenue": 540,
"sales": 12,
"previous_period_sales": 5,
"return": 0.01
},
{
"channel": "Amazon.ca",
"revenue": 675,
"sales": 15,
"previous_period_sales": 14,
"return": 0.02
},
{
"channel": "Ebay",
"revenue": 45,
"sales": 1,
"previous_period_sales": 1,
"return": 0.015
},
{
"channel": "Walmart",
"revenue": 225,
"sales": 5,
"previous_period_sales": 0,
"return": 0.005
},
{...}
]
},
"inventory": { // For current calendar day
"total": 265,
"velocity": 2.2, // total sales / # of days in date-range
"channels": [
{
"channel": "Local",
"total": 15
},
{
"channel": "Amazon.com",
"total": 100,
"velocity": 0.8 // channel sales / # of days in date-range
},
{
"channel": "Amazon.ca",
"total": 150,
"velocity": 1.0 // channel sales / # of days in date-range
},
{
"channel": "Ebay",
"total": 0,
"velocity": 0.1 // channel sales / # of days in date-range
},
{
"channel": "Walmart",
"total": 0,
"velocity": 0.3 // channel sales / # of days in date-range
},
{...}
]
},
"advertising": {
"spend": 155,
"sales": 1000,
"channels": [
{
"channel": "Amazon.com",
"spend": 150,
"sales": 500
},
{
"channel": "Amazon.ca",
"spend": 5,
"sales": 0
},
{
"channel": "Ebay",
"spend": 0,
"sales": 0
},
{
"channel": "Walmart",
"spend": 0,
"sales": 0
}
]
},
"purchasing": [
{
"po_date": "2019-05-02",
"po_number": 20,
"po_quantity": 50
},
{
"po_date": "2019-04-15",
"po_number": 19,
"po_quantity": 30
},
{
"po_date": "2019-02-25",
"po_number": 18,
"po_quantity": 235
},
{
"po_date": "2019-01-15",
"po_number": 17,
"po_quantity": 53
},
{
"po_date": "2019-01-01",
"po_number": 16,
"po_quantity": 20
}
]
},
{...},
{...}
]

Company Brands#

This endpoint shows overview data for a particular company's brands.

GET /overview/enterprise/:slug/:company/brands

Parameters#

  • slugrequired

    The parent enterprise's slug.

  • companyrequired

    The requested comapny's slug.

  • date_startrequiredformat: YYYY-MM-DD

    Start date for queried dataset.

  • date_endrequiredformat: YYYY-MM-DD

    End date for queried dataset.

  • page_sizeoptionaldefault: 10

    Number of results to return in response. Pass -1 for all results.

  • pageoptionaldefault: 1

    If returning paginated results, the page of results to return.

  • orderoptionaldefault: DESCoptions: DESC, ASC

    Ordering of response based on revenue key.

Returns#

Returns an array of brands with structured overview data over the defined time period.

Example Call#

/overview/enterprise/zquared/zq/brands?date_start=2019-05-01&date_end=2019-05-15

RESPONSE

[
{
"name": "Rockstar Widgets Brand",
"slug": "rockstar-widgets-brand",
"company": {
"name": "ZQ",
"slug": "zq"
}
"financials": {
"revenue": 1485, // sum of channels' values
"sales": 33, // sum of channels' values
"previous_period_sales": 20, // previous date range (i.e. if current is May 1-15, prev is Apr 15-30)
"return": 0.013, // Return Quantity / Sale Quantity; average of channels' values
"channels": [
{
"channel": "Amazon.com",
"revenue": 540,
"sales": 12,
"previous_period_sales": 5,
"return": 0.01
},
{
"channel": "Amazon.ca",
"revenue": 675,
"sales": 15,
"previous_period_sales": 14,
"return": 0.02
},
{
"channel": "Ebay",
"revenue": 45,
"sales": 1,
"previous_period_sales": 1,
"return": 0.015
},
{
"channel": "Walmart",
"revenue": 225,
"sales": 5,
"previous_period_sales": 0,
"return": 0.005
},
{...}
]
},
"inventory": { // For current calendar day
"total": 265,
"velocity": 2.2, // total sales / # of days in date-range
"channels": [
{
"channel": "Local",
"total": 15
},
{
"channel": "Amazon.com",
"total": 100,
"velocity": 0.8 // channel sales / # of days in date-range
},
{
"channel": "Amazon.ca",
"total": 150,
"velocity": 1.0 // channel sales / # of days in date-range
},
{
"channel": "Ebay",
"total": 0,
"velocity": 0.1 // channel sales / # of days in date-range
},
{
"channel": "Walmart",
"total": 0,
"velocity": 0.3 // channel sales / # of days in date-range
},
{...}
]
},
"advertising": {
"spend": 155,
"sales": 1000,
"channels": [
{
"channel": "Amazon.com",
"spend": 150,
"sales": 500
},
{
"channel": "Amazon.ca",
"spend": 5,
"sales": 0
},
{
"channel": "Ebay",
"spend": 0,
"sales": 0
},
{
"channel": "Walmart",
"spend": 0,
"sales": 0
}
]
},
"purchasing": [
{
"po_date": "2019-05-02",
"po_number": 20,
"po_quantity": 50
},
{
"po_date": "2019-04-15",
"po_number": 19,
"po_quantity": 30
},
{
"po_date": "2019-02-25",
"po_number": 18,
"po_quantity": 235
},
{
"po_date": "2019-01-15",
"po_number": 17,
"po_quantity": 53
},
{
"po_date": "2019-01-01",
"po_number": 16,
"po_quantity": 20
}
]
},
{...},
{...}
]