---
title: Endpoints
slug: docs/dFGH-endpoints
createdAt: 2025-02-02T09:29:20.250Z
---

## Generate Export

Generates a new export, and returns the export including the ID, the status of the export, and the link for the new export.

:::BlockQuote
**POST https\://acme.jomablue.com/api/v1/exports**
:::

### Properties

| **Property**    | **More**                                                                                                                                                                                                                                                      |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| exportable\_key | required<br />always 'event-people'                                                                                                                                                                                                                           |
| event\_id       | required<br />The numerical event id of the event you're requesting the report for                                                                                                                                                                            |
| filters         | badge = true \| false (if a person has checked in or not)<br />categories = array of category id's you want to filter on<br />sessions = array of sessions you want to filter on<br />inc = which attributes of the report do you want to include (see below) |



### "inc" Column Inclusions

This allows for additional columns to be requested in the report - by default, only the  The default includes all - but you may choose to remove certain columns from your report.&#x20;



- cat | Categories - Include a column per category and Y if a person is a member of that category
- itm | Item Entitlements - Include a column per item with a Y if entitled and timestamp if collected
- ses | Session Check In - Include a column per Session, with a timestamp with the recorded check-in time
- che | Session Check Out - Includes a column per Session, with a timestamp with the recorded check-out time
- sat | Session Attendance - Includes a column per Session with a Y if the person has attended that session
- sae | Session Allow Entry - Includes a column per Session with a Y if the session is restricted, and the person is entitled to attend that session&#x20;
- ven | Vendors - Includes a column per Vendor, and a timestamp with the latest interaction each Person had with that Vendor
- src | Session Related Content - Includes a column per Session, and a timestamp with the recorded time that Person requested Session Related Content
- tpt | Touchpoint - Includes a column per Touchpoint and a timestamp with the latest recorded time that Person interacted with each Touchpoint
- sj | Session Journey - Includes a formatted string containing a list of each Session that a Person attended, in the order that they attended them. This is formatted as Session names enclosed in square brackets, concatenated together (e.g. `[Session1][Session2][Session3]`)
- vj | Vendor Journey - Includes a formatted string containing a list of each Vendor that the Person interacted with. This string includes the name of each Vendor (in square brackets), followed by the tags that Vendor tagged the person with (in single curly brackets), any Vendor Emails they may have sent (in double curly brackets), and any notes that vendor recorded (in parentheses) - for example, `[Jomablue]{Hot}{{More Info Email}}(Notes text)`
- bim | Block Interaction Metrics - includes a column for each Block that collects interaction data, with interaction data for that Block (varies depending on Block type)
- cv | Canvas Views - includes two columns for each Canvas. The first contains a count of the number of times the person has viewed that Canvas, and the second contains a timestamp of the first time the person viewed that Canvas.
- aoi | Associated Order IDs - a single column containing the Order ID of the Order associated with each Person (if they were registered through Jomablue Paid Registration)






### Example Request Body

An example request is below:

```javascript
{
  "exportable_key": "event-people",
  "parameters": {
    "event_id": 1,
    "filter": {
      "badge": true,
      "categories": [
        1,
        2
      ],
      "inc": {
        "cat": true,
        "itm": true,
        "ses": true,
        "che": true,
        "sat": true,
        "sae": true,
        "src": true,
        "ven": true,
        "tpt": true,
        "sj": true,
        "vj": true,
        "bim": true,
        "cv": true,
        "aoi": true
      }
    }
  }
}
```

### Example Response

The request response includes data about the requested export, including:

- `type` - always `exports`
- `id` - the assigned ID for the export (used in later steps)
- `attributes` - attributes about the export, including:
  - `status` - can be `pending` or `complete`
  - `progress` - always null
  - `size` - always null
  - `expiresAt` - the time this export will expire (i.e. will no longer be able to be downloaded)
  - `createdAt` - the time the export was created
  - `updatedAt` - the time the export was last updated
- `links` - contains links relevant to the export:
  - `self` - the link to this specific export

Example response:

```javascript
{
    "data": {
        "type": "exports",
        "id": "5",
        "attributes": {
            "status": "pending",
            "progress": null,
            "size": null,
            "expiresAt": "2025-02-18T06:30:57.000000Z",
            "createdAt": "2025-02-17T06:30:57.000000Z",
            "updatedAt": "2025-02-17T06:30:57.000000Z"
        },
        "links": {
            "self": "https://acme.jomablue.com/api/v1/exports/5"
        }
    },
    "links": {
        "self": "https://acme.jomablue.com/api/v1/exports/5"
    }
}
```

## Get Export Status

Gets the progress of an export, and the download link for the export (if the export is complete).

:::BlockQuote
GET [https://acme.jomablue.com/api/v1/exports](https://acme.jomablue.com/api/v1/exports)/&#x7B;export\_id}
:::

The request response includes data about the requested export, including :

- `type` - always `exports`
- `id` - the assigned ID for the export (used in later steps)
- `attributes` - attributes about the export, including:
  - `status` - can be `pending` or `complete`
  - `progress` - the current progress of the report, in terms of rows completed
  - `size` - the size of the entire report in terms of rows
  - `expiresAt` - the time this export will expire (i.e. will no longer be able to be downloaded)
  - `createdAt` - the time the export was created
  - `updatedAt` - the time the export was last updated
- `links` - contains links relevant to the export:
  - `self` - the link to this specific export
  - `download` - the URI to request a download link for this export

Example response:

```javascript
{
    "data": {
        "type": "exports",
        "id": "5",
        "attributes": {
            "status": "complete",
            "progress": 10,
            "size": 10,
            "expiresAt": "2025-02-18T06:30:57.000000Z",
            "createdAt": "2025-02-17T06:30:57.000000Z",
            "updatedAt": "2025-02-17T06:31:00.000000Z"
        },
        "links": {
            "self": "https://acme.jomablue.com/api/v1/exports/5",
            "download": "https://acme.jomablue.com/api/v1/exports/5/download"
        }
    },
    "links": {
        "self": "https://acme.jomablue.com/api/v1/exports/5"
    }
}
```

## Get Download Link

Get the download link for an export that has completed.

:::BlockQuote
GET [https://acme.jomablue.com/api/v1/exports](https://acme.jomablue.com/api/v1/exports)/&#x7B;export\_id}/download
:::

The request response includes data about the requested download, including :

- `type` - always `downloads`
- `id` - the assigned ID for the export
- `attributes` - attributes about the export, including:
  - `uuid` - the uuid for this download's file (used internally)
  - `url` - the temporarily signed URL for this download. Valid for 5 minutes.
- `links` - contains links relevant to the export:
  - `self` - the link to this specific download

### Example response:

```javascript
{
    "data": {
        "type": "downloads",
        "id": "5",
        "attributes": {
            "uuid": "tmp/a21e0d92-e8ce-45a5-8d24-6c693771ee02",
            "url": "https://jomablue-acme.s3.ap-southeast-2.amazonaws.com/tmp/a21e0d92-e8ce-45a5-8d24-6c693771ee02?r..."
        },
        "links": {
            "self": "https://acme.jomablue.com/api/v1/exports/5/download"
        }
    },
    "links": {
        "self": "https://acme.jomablue.com/api/v1/exports/5/download"
    }
}
```

