Endpoints

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 post https //acme jomablue com/api/v1/exports properties property more exportable key required always 'event people' event id required 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) categories = array of category id's you want to filter on sessions = array of sessions you want to filter on 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 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 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 { "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 { "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) get https //acme jomablue com/api/v1/exports /{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 { "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 get https //acme jomablue com/api/v1/exports /{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 { "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" } }