API docs by Redocly

Reporting Service (1.0)

Download OpenAPI specification:

Amusement Connect: api@amusementconnect.com URL: https://amusementconnect.com License: MIT License

Amusement Connect API for interacting with reporting data.

Cashbox

GetCashboxCollectionData

Authorizations:
apiKey
path Parameters
locationId
required
string <uuid>
query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The requested API version

Responses

Response samples

Content type
No sample

Collections

GetCollections

Authorizations:
apiKey
path Parameters
locationId
required
string <uuid>
query Parameters
top
integer <int32>
skip
integer <int32>

Responses

Response samples

Content type
No sample

GetCollection

Authorizations:
apiKey
path Parameters
locationId
required
string <uuid>
collectionId
required
string <uuid>

Responses

Response samples

Content type
No sample

ExportCollection

Authorizations:
apiKey
path Parameters
locationId
required
string <uuid>
collectionId
required
string <uuid>
query Parameters
documentType
string
Default: "pdf"

Responses

GenerateCommissionReport

Authorizations:
apiKey
path Parameters
locationId
required
string <uuid>
query Parameters
fromDate
string <date-time>
toDate
string <date-time>
documentType
string
Default: "pdf"

Responses

ExternalLocation

GetLocationRevenueAsync

Authorizations:
apiKey
query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The requested API version

Request Body schema:
locations
Array of strings or null <uuid> unique [ items <uuid > ]
startDate
string <date-time>
endDate
string <date-time>

Responses

Request samples

Content type
{
  • "locations": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z"
}

GetLocationGameReportsAsync

Authorizations:
apiKey
query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The requested API version

Request Body schema:
locations
Array of strings or null <uuid> unique [ items <uuid > ]
startDate
string <date-time>
endDate
string <date-time>

Responses

Request samples

Content type
{
  • "locations": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z"
}

Organization

GetRevenueAsync

Authorizations:
apiKey
query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The requested API version

Request Body schema:
One of
startDate
string <date-time>
endDate
string <date-time>
organizationId
string <uuid>

Responses

Request samples

Content type
Example
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9"
}

Response samples

Content type
No sample

GetGamePlayAsync

Authorizations:
apiKey
query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The requested API version

Request Body schema:
One of
startDate
string <date-time>
endDate
string <date-time>
organizationId
string <uuid>

Responses

Request samples

Content type
Example
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9"
}

Response samples

Content type
No sample

GetOperatorReportAsync

Authorizations:
apiKey
query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The requested API version

Request Body schema:
startDate
string <date-time>
endDate
string <date-time>
organizationId
string <uuid>
toEmail
required
string non-empty

Responses

Request samples

Content type
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "toEmail": "string"
}

Response samples

Content type
No sample

GetOrganizationGameEarningsAsync

Authorizations:
apiKey
query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The requested API version

Request Body schema:
startDate
string <date-time>
endDate
string <date-time>
organizationId
string <uuid>
games
Array of strings or null
categories
Array of strings or null
businessTypes
Array of strings or null
regions
Array of strings or null
threshold
integer <int32>
suppressOutliers
boolean

Responses

Request samples

Content type
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "games": [
    ],
  • "categories": [
    ],
  • "businessTypes": [
    ],
  • "regions": [
    ],
  • "threshold": 0,
  • "suppressOutliers": true
}