Skip to main content
GET
/
report
Retrieve Custom Report
curl --request GET \
  --url https://api.nuwebgroup.com/v1/report \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "type": "reports",
    "id": 1,
    "attributes": {
      "name": "Report name",
      "description": "Report description"
    },
    "links": {
      "first": "http://api.upton.com/v1/report?id=1&page=2",
      "last": "http://api.upton.com/v1/report?id=1&page=2",
      "prev": null,
      "next": null,
      "self": "http://api.upton.com/v1/report?id=1"
    },
    "meta": {
      "total": 1,
      "pageTotal": 1,
      "limit": 10
    },
    "rows": [
      {
        "barcode": "PREF-RO3PM2VPE1",
        "purchaserEmail": "[email protected]",
        "itemName": "Ticket 3",
        "itemStatus": "valid",
        "orderReference": "3RJPYN0GZV",
        "reservationCompletedAt": "Fri, 18th February, 2022 10:56 AM",
        "eventName": "Event 2020",
        "firstScanInDate": null,
        "customHeader": "custom value"
      }
    ],
    "dataLastSynchronised": "2022-02-22T12:54:22.000000Z",
    "headers": {
      "barcode": "Barcode",
      "purchaserEmail": "Purchaser email",
      "itemName": "Item name",
      "itemStatus": "Item status",
      "orderReference": "Order reference",
      "reservationCompletedAt": "Reservation completed at",
      "eventName": "Event name",
      "firstScanInDate": "First scan in date",
      "customHeader": "Custom header"
    }
  }
}

Authorizations

ā€‹
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Query Parameters

ā€‹
id
integer

The custom report ID.

ā€‹
page
integer

The page you wish to retrieve reports.

ā€‹
limit
integer

Number of results per page. Max value is 100 for synchronous requests, or 1000 for asynchronous requests

ā€‹
refresh
boolean
default:false

For performance reasons, some of our reports are cached for a short period of time. Cached results are signified if the dataLastSynchronised attribute exists in the body of the response. To clear this cache, set this value to true.

ā€‹
async
boolean

Whether to execute the request asyncronously

ā€‹
asyncUuid
string

UUID for the async request

Response

Successfully retrieved the custom report.

ā€‹
data
object