Show notification detail

GET /api/notifications/{id}/detail
Api key

Allows you to retrieve the booth-level breakdown of a single notification.

Path parameters

  • id string Required

    the ID of the notification to retrieve

Query parameters

  • sort string

    criteria to sort by

  • limit string

    amount of results per page to return

  • page string

    page number

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • data array[object]

      Notification detail data

      Hide data attributes Show data attributes object
      • booth_id string

        ID of the event definition in the system.

      • booth_name string

        The booth name

      • event_count number

        The number of events in the event notification for this booth

      • facility_name string

        The facility name

      • region_name string

        The region name

    • limit number

      The number of items per page currently applied

    • page number

      The number of the page returned

    • pages number

      The total number of pages matching the current search

    • total number

      The total number of regions matching the query
  • 401 application/json

    Unauthorized

    Hide response attribute Show response attribute object
    • error string

      Human readable version of the error status code
  • 404 application/json

    Not Found

    Hide response attribute Show response attribute object
    • error string

      Human readable version of the error status code
GET /api/notifications/{id}/detail 
curl \
 --request GET 'http://localhost:4000/api/notifications/{id}/detail' \
 --header "Authorization: $API_KEY"
Response examples (200) 
{
  "data": [
    {
      "booth_id": "f260f115-f2e6-4dde-bcab-98b10fdb8cf6",
      "booth_name": "Booth 1",
      "event_count": 3,
      "region_name": "US East",
      "facility_name": "Facility 1"
    }
  ],
  "page": 1,
  "limit": 1,
  "pages": 20,
  "total": 20
}
Response examples (401) 
{
  "error": "Error Reason"
}
Response examples (404) 
{
  "error": "Error Reason"
}