Get Scanning stats for an event

GET 
/event/:guid/scanningstats

Retrieve scanning statistiscs for an Event.

Request

Path Parameters

guid uuidrequired

The guid of the Event.

Responses

200

The scanning statistics found.

application/json

Schema

Schema

• Array [

tickets

object[]

Array [

:ticket_guid

object

guid uuid

The guid of the Ticket Type scanned.

name string

Name of the Ticket Type.

sold_count integer

The sold amount of this Ticket Type.

scanned_count integer

The amount scanned of this Ticket Type.

date_info undefined[]

]

products

object[]

Products scanned.

Array [

:product_guid

object

guid uuid

The guid of the Product Type scanned.

name string

Name of the Product Type.

sold_count integer

The sold amount of this Product Type.

scanned_count integer

The amount scanned of this Product Type.

date_info undefined[]

]

scannertypes

object

:scanner_type_guid object[]

scanners

object

:scanner_guid

object

guid uuid

The guid of the Scanner.

name string

The name of the Scanner.

scanner_type_id uuid

The guid of the ScannerType.

scanner_type_name string

The name of the ScannerType.

last_seen ISO 8601

When the scanner was last seen online.

battery_percentage integer

Battery level.

battery_status string

Status of the battery, i.e. charging, discharing.

scan_chart

object

:ticket_guid

object[]

Array [

ticket_id string

The guid of the Ticket Type.

hour string

When the Ticket Type was scanned.

scan_count integer

The amount of Ticket Types that were scanned.

]

• ]

Example (from schema)

[
  {
    "tickets": [
      {
        ":ticket_guid": {
          "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "sold_count": 0,
          "scanned_count": 0,
          "date_info": [
            null
          ]
        }
      }
    ],
    "products": [
      {
        ":product_guid": {
          "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "sold_count": 0,
          "scanned_count": 0,
          "date_info": [
            null
          ]
        }
      }
    ],
    "scannertypes": {
      ":scanner_type_guid": [
        {
          "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "event_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "description": "string",
          "username": "string",
          "password": "string",
          "visibility": 115,
          "scan_types": 68719476735,
          "expires_at": "string",
          "QR": "string",
          "created_at": "string",
          "updated_at": "string",
          "deleted_at": "string",
          "scanner_count": 0,
          "scanners": [
            {
              "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "scanner_type_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "name": "string",
              "visibility": 0,
              "scan_types": 0,
              "app_version": "string",
              "ccna_version": "string",
              "platform": "ios",
              "platform_version": "string",
              "expires_at": "string",
              "created_at": "string",
              "updated_at": "string",
              "pings": {
                "scanner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "created_at": "string",
                "submitted_at": "string",
                "name": "string",
                "battery_percentage": 0,
                "battery_status": "charging",
                "network_quality": 0,
                "network_type": "wifi",
                "latitude": 0,
                "longitude": 0,
                "precision": 0,
                "max_scanner_id": "string",
                "max_created_at": "string"
              }
            }
          ]
        }
      ]
    },
    "scanners": {
      ":scanner_guid": {
        "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "scanner_type_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "scanner_type_name": "string",
        "last_seen": "string",
        "battery_percentage": 0,
        "battery_status": "string"
      }
    },
    "scan_chart": {
      ":ticket_guid": [
        {
          "ticket_id": "string",
          "hour": "string",
          "scan_count": 0
        }
      ]
    }
  }
]

404

Event not found.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

Loading...