Skip to content

Latest commit

 

History

History
164 lines (113 loc) · 5.22 KB

analytics.md

File metadata and controls

164 lines (113 loc) · 5.22 KB
Raw

Analytics


General Statistics

For all barcodes:

  • GET /analytics/GetAllBarcodesStatistics? return scans statistics for all barcodes for all time
  • GET /analytics/GetAllBarcodesStatistics?fromDate={date}toDate{date} return scans statistics for all barcodes for selected date period

For specific barcode:

  • GET /analytics/GetBarcodeStatistics?id={id} return scans statistics for specific barcode by its id for all time
  • GET /analytics/GetBarcodeStatistics?id={id}?fromDate={date}&toDate={date} return scans statistics for specific barcode by it id for selected date period

For specific folder:

  • GET /analytics/GetFolderStatistics?folderId={id} return scans statistics for specific folder by its id for all time
  • GET /analytics/GetFolderStatistics?folderId={id}?fromDate={date}&toDate={date} return scans statistics for specific folder by its id for selected date period

Request optional parameters:

fromDate - Start date. Format: "YYYY-MM-DD"
toDate - End date. Format: "YYYY-MM-DD"

Response data type: Scans


Statistics Examples

For all barcodes:

For specific barcode:

For specific folder:

Response:

Status: 200 OK

{
  "uniqueScans": 131,
  "totalScans": 858
}

Daily Statistics

For specific barcode:

  • GET /analytics/daily/{id} return all scans statistics detailed by days for specific barcode.
  • GET /analytics/daily/{id}?fromDate={date}&toDate={date} return scans statistics detailed by days for specific barcode for selected date range. If selected single day (fromDate equals to toDate), than statistics by hours will be returned.

For specific folder:

  • GET /analytics/daily?folderId={id} return all scans statistics detailed by days for specific folder.
  • GET /analytics/daily?folderId={id}&fromDate={date}&toDate={date} return scans statistics detailed by days for specific folder for selected date range. If selected single day (fromDate equals to toDate), than statistics by hours will be returned.

Statistics Examples

For specific barcode:

For specific folder:

Request optional parameters:

fromDate - Start date. Format: "YYYY-MM-DD"
toDate - End date. Format: "YYYY-MM-DD"

Response data type: DayScans

Response:

Status: 200 OK

[
 {
    "date": "2012-03-24T00:00:00-05:00",
    "uniqueScans": 723,
    "totalScans": 689
 }
]

Detailed Statistics

For specific barcode:

  • GET /analytics/scans/{id} return list of all scans for specific barcode.
  • GET /analytics/scans/{id}?fromDate={date}&toDate={date} return list of scans for specific barcode for selected date range.

For specific folder:

  • GET /analytics/scans?folderId={id} return list of all scans for specific folder.
  • GET /analytics/scans?folderId={id}&fromDate={date}&toDate={date} return list of scans for specific folder for selected date range.

Statistics Examples

For specific barcode:

For specific folder:

Request optional parameters:

fromDate - Start date. Format: "YYYY-MM-DD"
toDate - End date. Format: "YYYY-MM-DD"

Response data type: ScanDetails

Response:

Status: 200 OK

[
 {
    "barcodeId": 2032,
    "barcodeType": "url",
    "barcodeLabel": "magazine",
    "barcodeContent": "http://google.com",
    "folderName": "Default",
    "scanDateTime": "2012-03-24T11:00:39-05:00",
    "city": "San Francisco",
    "country": "USA",
    "device": "iPhone",
    "ipAddress": "168.124.123.100",
    "provider": "ProviderInc.",
 }
]