Access Data with Vuforia APIs > Vuforia APIs > Accessing Procedure Execution Data > Make the API Call > Available Parameters
  
Available Parameters
The API outlined in this section (/customer-events/<org ID>/report) fetches a list of Vuforia Expert Capture procedure sessions sorted newest to oldest. By default, all sessions will be returned, and the results can be filtered using one or more parameters. The results are then divided into 100 session pages, with each page containing a link to the next page.
* 
Unless a query parameter has a default value, such as the granularity or progress parameters, it's ignored by default.
The following table provides information about all available parameters that can be used to filter results in the API.
• When using POST method, enter the parameters in the body of the request. For example:
{ "serialNumber": "serialNo", "granularity": "step" }
• When using the deprecated GET endpoint, enter the parameters as URL query parameters. For example:
/report?serialNumber=serialNo&granularity=step
Parameter
Type
Description
all
boolean
(query)
Set the page size to 64533 entries. If not set, a single page of 100 sessions will be returned along with a nextLink link to the next page.
endTime
string($date-time)
(query)
Reports only sessions started on or before the specified UTC date-time in RFC3339 format.
Example: 2022-10-11T19:30:44.005Z
failures
(query)
Excludes or exclusively includes sessions with failed steps. This parameter can be set to any of the following values:
• exclude—excludes all sessions with one or more failed steps
• only—returns only sessions that have one or more failed steps
feedback
array[string]
(query)
Reports sessions with the specified feedback status. This parameter can be set to any of the following values:
• incomplete—returns sessions that have at least one step for which required feedback was skipped
• complete—returns sessions for which all steps with required feedback have been completed
• na—returns all sessions that have no steps that require feedback or sessions that were either abandoned or are still in progress
granularity
string
(query)
Specifies the level of granularity for the session. This parameter can be set to any of the following values:
• procedure—returns session data about the procedure without step data
• step—returns session data about the procedure including step data
By default, this is set to procedure.
latestStepState
string
(query)
Reports only the latest change to a step when set to true. By default, this is set to true for POST method, and set to false for GET method.
organizationId (Required)
string($uuid)
(path)
The ID for your organization. This is required.
procedureId (GET only)
string
(query)
Reports only sessions with the specified procedure ID.
procedureIds (POST only)
array[string]
(query)
Reports only sessions belonging to one of the specified procedures.
procedureStatus
* 
This parameter has been deprecated.
Because this parameter is deprecated, we recommend using the feedback parameter instead.
Available values include incomplete and complete.
progress
array[string]
(query)
Reports sessions that with the specified progress status. This parameter can be set to any of the following values:
• completed—the frontline worker completed and submitted the session
• abandoned—the frontline worker deleted the session
• ongoing—the frontline worker has not yet completed and submitted the session; the session is still in progress
By default, this is set to completed.
serialNumber
string
(query)
Reports session data for procedures with the specified serial number.
startTime
string($date-time)
(query)
Reports only sessions started on or after the specified UTC date-time in RFC3339 format.
Example: 2022-10-11T19:30:44.005Z
x-correlation-id
string($uuid)
(header)
Optional user-provided UUID used for debugging purposes. If one is not set, one is automatically generated. Each request should have a unique x-correlation-id.
Example: 25aa3648-7609-47cc-aa21-ce0a1ob0cb10