AlphaAlpha Docs
API Reference

Analytics

API calls concerning stats

Retrieve stats

GET
/analytics

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/analytics"
{
  "materialStream": [
    {
      "date": "2019-08-24T14:15:22Z",
      "value": 0.1
    }
  ]
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Retrieve invoice revenue over time

GET
/analytics/invoice-revenue

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

groupingScale?string
Value in"DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR"
start*string
Formatdate-time
end*string
Formatdate-time

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/analytics/invoice-revenue?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
{
  "data": [
    {
      "date": "string",
      "values": [
        {
          "name": "string",
          "value": 0.1
        }
      ]
    }
  ],
  "series": [
    {
      "color": "string",
      "name": "string"
    }
  ]
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Retrieve top clients by invoice revenue

GET
/analytics/invoice-top-clients

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

start*string
Formatdate-time
end*string
Formatdate-time

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/analytics/invoice-top-clients?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
[
  {
    "averageOrderValue": 0.1,
    "clientAvatar": {
      "blobId": "string",
      "height": 0,
      "thumbnailBlobId": "string",
      "width": 0
    },
    "clientId": "string",
    "clientName": "string",
    "totalAmount": 0.1,
    "totalOrders": 0
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Retrieve top products by invoice revenue

GET
/analytics/invoice-top-products

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

start*string
Formatdate-time
end*string
Formatdate-time

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/analytics/invoice-top-products?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
[
  {
    "productId": "string",
    "productInfo": {
      "brand": "string",
      "category": "string",
      "description": "string",
      "imageBlobId": "string",
      "name": "string",
      "productId": "string",
      "salesPrice": 0.1,
      "stockInfo": {
        "amountAvailable": 0.1,
        "amountReserved": 0.1,
        "baseUnit": {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        },
        "currency": "string",
        "destinationProductInfo": {
          "amountAvailable": 0.1,
          "amountReserved": 0.1,
          "maximum": 0.1,
          "minimum": 0.1,
          "stockSiteId": "string",
          "stockSiteName": "string",
          "totalAmount": 0.1
        },
        "imageBlobId": "string",
        "maximum": 0.1,
        "minimum": 0.1,
        "productId": "string",
        "productName": "string",
        "productType": "RAW_MATERIAL",
        "salesPrice": 0.1,
        "stockSiteId": "string",
        "stockSiteName": "string",
        "subsidiaryId": "string",
        "totalAmount": 0.1,
        "unitPrice": 0.1,
        "unitsOfMeasurement": [
          {
            "baseUnit": true,
            "cost": 0.1,
            "decimal": true,
            "isBaseUnit": true,
            "isDecimal": true,
            "name": "string",
            "quantity": 0.1,
            "salesPrice": 0.1,
            "unit": "string"
          }
        ]
      },
      "unitPrice": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    },
    "totalPrice": 0.1,
    "totalQuantity": 0.1
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Retrieve product revenue

GET
/analytics/product-revenue

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

groupingScale?string
Value in"DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR"
start*string
Formatdate-time
end*string
Formatdate-time

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/analytics/product-revenue?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
{
  "data": [
    {
      "date": "string",
      "values": [
        {
          "name": "string",
          "value": 0.1
        }
      ]
    }
  ],
  "series": [
    {
      "color": "string",
      "name": "string"
    }
  ]
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Retrieve product statistics

GET
/analytics/product-stats/{productId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

productId*string

Query Parameters

groupingScale?string
Value in"DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR"
start*string
Formatdate-time
end*string
Formatdate-time

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/analytics/product-stats/string?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
{
  "data": [
    {
      "date": "string",
      "values": [
        {
          "name": "string",
          "value": 0.1
        }
      ]
    }
  ],
  "series": [
    {
      "color": "string",
      "name": "string"
    }
  ]
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Retrieve revenue split

GET
/analytics/revenue-split

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

start*string
Formatdate-time
end*string
Formatdate-time

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/analytics/revenue-split?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
[
  {
    "name": "string",
    "revenue": 0.1,
    "subsidiaryId": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Retrieve worst performing products

GET
/analytics/worst-products

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

start*string
Formatdate-time
end*string
Formatdate-time

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/analytics/worst-products?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
[
  {
    "productId": "string",
    "productInfo": {
      "brand": "string",
      "category": "string",
      "description": "string",
      "imageBlobId": "string",
      "name": "string",
      "productId": "string",
      "salesPrice": 0.1,
      "stockInfo": {
        "amountAvailable": 0.1,
        "amountReserved": 0.1,
        "baseUnit": {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        },
        "currency": "string",
        "destinationProductInfo": {
          "amountAvailable": 0.1,
          "amountReserved": 0.1,
          "maximum": 0.1,
          "minimum": 0.1,
          "stockSiteId": "string",
          "stockSiteName": "string",
          "totalAmount": 0.1
        },
        "imageBlobId": "string",
        "maximum": 0.1,
        "minimum": 0.1,
        "productId": "string",
        "productName": "string",
        "productType": "RAW_MATERIAL",
        "salesPrice": 0.1,
        "stockSiteId": "string",
        "stockSiteName": "string",
        "subsidiaryId": "string",
        "totalAmount": 0.1,
        "unitPrice": 0.1,
        "unitsOfMeasurement": [
          {
            "baseUnit": true,
            "cost": 0.1,
            "decimal": true,
            "isBaseUnit": true,
            "isDecimal": true,
            "name": "string",
            "quantity": 0.1,
            "salesPrice": 0.1,
            "unit": "string"
          }
        ]
      },
      "unitPrice": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    },
    "totalPrice": 0.1,
    "totalQuantity": 0.1
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Admin Users

Previous Page

A P Invoices

Next Page