Authentication

Authentication API

Authentication API will perform basic authentication into Newmetrix and return API token that will be used for subsequent API calls. The value of 'token' in the response will have to be supplied in 'X-Auth-Token' HTTP header with every API. Token needs to be refreshed once expired.

'expires' will specify token expiration time measured in milliseconds from midnight, January 1, 1970 UTC.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/authenticate/http-request.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/authenticate/request-fields.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/authenticate/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/authenticate/http-response.adoc[]

Observations

Observations retrieve API

Observations retrieve API can be used to retrieve observations with their related data, such as trade partners, assignees, etc, from the system for a set of project(s). Observations retrieve API supports incremental date-based retrieval and pagination.

If custom configuration is enabled for the organization, custom field values will be returned as part of each observation.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-observations/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-observations/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-observations/request-parameters.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-observations/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-observations/http-response.adoc[]

Get Observation API

Get Observation API can be used to retrieve an observation with it’s related data, such as trade partners, assignees, etc, from the system.

If custom configuration is enabled for the organization, custom field values will be returned as part of the observation.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-observation/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-observation/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-observation/request-parameters.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-observation/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-observation/http-response.adoc[]

Create Observations API

Create Observations API can be used to import a list of observations into the system. Create Observations API accepts file names and URLs for downloading and associating images with observations

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/create-observations/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/create-observations/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/create-observations/request-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/create-observations/request-fields.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/create-observations/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/create-observations/http-response.adoc[]

Update Observation API

Update Observation API can be used to update an observations in the system. Update Observation API requires the full observation object be sent with desired fields updated. For existing observation the following fields cannot be updated: id, projectId and externalObservationId.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-observation/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-observation/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-observation/request-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-observation/request-fields.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-observation/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-observation/http-response.adoc[]

Delete Observation API

Delete Observation API can be used to delete an observations from the system.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-observation/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-observation/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-observation/request-parameters.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-observation/http-response.adoc[]

Get Failed Download Files For Observation API

Get Failed Download Files For Observation API can be used to retrieve a list of files that failed to download into the system for a particular observation.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-failed-downloads-observation/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-failed-downloads-observation/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-failed-downloads-observation/request-parameters.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-failed-downloads-observation/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-failed-downloads-observation/http-response.adoc[]

Projects

Sync Projects API

Sync Project API is used to create new or update existing projects in Newmetrix.
The organizationId path parameter must match to all of the organizationId’s in the payload, this means that user can sync only the projects from a single organization in a single call to this API.
The system will try to locate existing projects based on the projectExternalId or id depending on the value of the useExternalId parameter.
For existing projects only the following fields can be updated: name, description, location and projectNumber.
The API is limited to work with 100 projects at a time.
User calling this API must have permission to manage projects for each projects' organization specified.
Upon successful execution the API returns response payload along with 200 response code.
For any incorrect parameters passed the response code 400 is returned.
For any permission related errors the response code 401 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/sync-project/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/sync-project/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/sync-project/request-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/sync-project/request-fields.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/sync-project/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/sync-project/http-response.adoc[]

Update Project’s external ID API

Update Project’s external ID API is used to update an external ID of an existing project in Newmetrix.
User calling this API must have permission to manage projects in the organization to which the project belongs to.
Upon successful execution the API returns response payload along with 200 response code.
For any incorrect parameters passed or in case where the project with a given external ID already exists in the given organization the response code 400 is returned.
To set an external ID for the project that doesn’t have one, omit the oldId field in the request payload.
For any permission related errors the response code 401 is returned.
If project cannot be found the response code 404 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-project-ext-id/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-project-ext-id/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-project-ext-id/request-fields.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-project-ext-id/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-project-ext-id/http-response.adoc[]

Update Project’s Project Group

Update Project’s Project Group ID API is used to update a project group ID of an existing project in Newmetrix.
User calling this API must have permission to manage projects in the source and target project groups
Upon successful execution the API returns response payload along with 200 response code.
For any permission related errors the response code 401 is returned.
If project cannot be found the response code 404 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-project-group-id/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-project-group-id/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-project-group-id/request-fields.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-project-group-id/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-project-group-id/http-response.adoc[]

Get Project API

Get Project API is used to get an existing project from Newmetrix.
The project is retrieved based on the projectExternalId or id depending on the value of the useExternalId parameter.
User calling this API must have permission to access the organization to which the project belongs to.
Upon successful execution the API returns response payload along with 200 response code.
For any incorrect parameters passed the response code 400 is returned.
For any permission related errors the response code 401 is returned.
If project cannot be found the response code 404 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-project/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-project/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-project/request-parameters.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-project/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-project/http-response.adoc[]

Set Project Status API

Set Project Status API is used to set 'active' or 'inactive' status for an existing project from Newmetrix.
The client executing request must provide either projectExternalId or internal project id as the value of the path variable {projectId} depending on the value of useExternalId parameter.
User calling this API must have permission to access the organization to which the project belongs to.
Upon successful execution the API returns response payload along with 200 response code.
For any incorrect parameters passed the response code 400 is returned.
For any permission related errors the response code 401 is returned.
If project cannot be found the response code 404 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/project-set-status/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/project-set-status/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/project-set-status/request-parameters.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/project-set-status/http-response.adoc[]

Get Projects API

Get Projects API is used to get the organization’s projects from Newmetrix.
The returned list of projects is always sorted by name in the alphabetical order. User calling this API must have permission to access the organization to which the projects belong to.
Upon successful execution the API returns response payload along with 200 response code.
For any incorrect parameters passed the response code 400 is returned.
For any permission related errors the response code 401 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-projects/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-projects/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-projects/request-parameters.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-projects/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-projects/http-response.adoc[]

Delete Project API

Delete Project API is used to delete an existing project from Newmetrix.
This API deletes project and all project related data (e.g. assets, observations, etc.).
The project is deleted based on the projectExternalId or id depending on the value of the useExternalId parameter.
User calling this API must have permission to manage projects in the organization to which the project belongs to.
Upon successful execution the API returns 204 response code.
For any incorrect parameters passed the response code 400 is returned.
For any permission related errors the response code 401 is returned.
Client calling this API will not receive an error if the project specified by the ID cannot be not found, the response code 204 is returned in this case instead.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-project/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-project/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-project/request-parameters.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-project/http-response.adoc[]

Trade Partners

Sync Trade Partners API

Sync Trade Partners API is used to create new or update existing trade partners in Newmetrix.
The organizationId path parameter must match to all of the organizationId’s in the payload, this means that user can sync only the trade partners from a single organization in a single call to this API.
This API allows users to optionally set tradePartnerExternalId’s for each trade partner as another form of identification. Each tradePartnerExternalId must be unique (unless empty) across the organization.
The system will try to locate existing trade partners based on the tradePartnerExternalId or id depending on the value of the useExternalId parameter.
For existing trade partners the following fields cannot be updated: id, organizationId and externalTradePartnerId.
The API is limited to work with 100 trade partners at a time.
User calling this API must have permission to create and update trade partners for the organization specified.
Upon successful execution the API returns response payload along with 200 response code.
For any incorrect parameters passed the response code 400 is returned.
For any permission related errors the response code 401 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/sync-trade-partner/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/sync-trade-partner/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/sync-trade-partner/request-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/sync-trade-partner/request-fields.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/sync-trade-partner/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/sync-trade-partner/http-response.adoc[]

Get Trade Partner API

Get Trade Partner API is used to get an existing trade partner from Newmetrix.
The trade partner is retrieved based on the tradePartnerExternalId or id depending on the value of the useExternalId parameter.
User calling this API must have permission to access the trade partners in the organization with which the trade partner is associated.
Upon successful execution the API returns response payload along with 200 response code.
For any incorrect parameters passed the response code 400 is returned.
For any permission related errors the response code 401 is returned.
If trade partner cannot be found the response code 404 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partner/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partner/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partner/request-parameters.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partner/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partner/http-response.adoc[]

Get Trade Partners for Organization API

Get Trade Partners for Organization API is used to obtain a paged list of trade partners for a given organization from Newmetrix.
It returns a sorted (by name) and paged list of trade partners where maximum page size cannot exceed 100 items.
User calling this API must have permission to access the trade partners in the organization with which the trade partners are associated.
Upon successful execution the API returns response payload along with 200 response code.
For any incorrect parameters passed the response code 400 is returned.
For any permission related errors the response code 401 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partners-for-org/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partners-for-org/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partners-for-org/request-parameters.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partners-for-org/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partners-for-org/http-response.adoc[]

Get Trade Partners for Project API

Get Trade Partners for Project API is used to obtain a paged list of trade partners for a given project from Newmetrix.
It returns a sorted (by name) and paged list of trade partners where maximum page size cannot exceed 100 items.
User calling this API must have permission to access the trade partners in the project of the organization with which the trade partners are associated.
Upon successful execution the API returns response payload along with 200 response code.
For any incorrect parameters passed the response code 400 is returned.
For any permission related errors the response code 401 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partners-for-project/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partners-for-project/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partners-for-project/request-parameters.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partners-for-project/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-trade-partners-for-project/http-response.adoc[]

Delete Trade Partner API

Delete Trade Partner API is used to delete an existing trade partner from Newmetrix.
The trade partner is deleted based on the tradePartnerExternalId or id depending on the value of the useExternalId parameter.
User calling this API must have permission to delete trade partners in the organization with which the trade partner is associated.
Upon successful execution the API returns 204 response code.
For any incorrect parameters passed the response code 400 is returned.
For any permission related errors the response code 401 is returned.
Client calling this API will not receive an error if the trade partner specified by the ID cannot be not found, the response code 204 is returned in this case instead.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-trade-partner/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-trade-partner/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-trade-partner/request-parameters.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-trade-partner/http-response.adoc[]

Assign Trade Partners to Project API

Assign Trade Partners to Project API is used to assign maltiple trade partners specified by their IDs to an existing project in Newmetrix.
The trade partners' IDs are either internal Newmetrix IDs or external trade partners IDs based on the useExternalId parameter.
User calling this API must have permission to assign trade partners to the project in the organization with which the trade partner is associated.
Upon successful execution the API returns 201 response code.
For any incorrect parameters passed the response code 400 is returned.
For any permission related errors the response code 401 is returned.
If trade partner or the project cannot be found the response code 404 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/assign-trade-partner-to-project/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/assign-trade-partner-to-project/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/assign-trade-partner-to-project/request-parameters.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/assign-trade-partner-to-project/http-response.adoc[]

Remove Trade Partner from Project API

Remove Trade Partner from Project API is used to remove a trade partner specified by ID from an existing project in Newmetrix.
The trade partner’s ID is either internal Newmetrix ID or external trade partner’s ID based on the useExternalId parameter.
User calling this API must have permission to remove trade partners from the project in the organization with which the trade partner is associated.
Upon successful execution the API returns 201 response code.
For any incorrect parameters passed the response code 400 is returned.
For any permission related errors the response code 401 is returned.
If trade partner or the project cannot be found the response code 404 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/remove-trade-partner-from-project/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/remove-trade-partner-from-project/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/remove-trade-partner-from-project/request-parameters.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/remove-trade-partner-from-project/http-response.adoc[]

Update Trade partner’s external ID API

Update Trade partner’s external ID API is used to update an external ID of an existing trade partner in Newmetrix.
User calling this API must have permission to manage projects and access trade partners in the organization to which the project belongs to.
Upon successful execution the API returns response payload along with 200 response code.
For any incorrect parameters passed or in case where the trade partner with a given external ID already exists in the given organization the response code 400 is returned.
To set an external ID for the trade partner that doesn’t have one, omit the oldId field in the request payload.
For any permission related errors the response code 401 is returned.
If trade partner’s cannot be found the response code 404 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-trade-partner-ext-id/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-trade-partner-ext-id/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-trade-partner-ext-id/request-fields.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-trade-partner-ext-id/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-trade-partner-ext-id/http-response.adoc[]

Users and project members

Invite Users To Project Group API

Invite Users To Project Group API can be used to invite new or existing users to a project group.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/invite-users-to-project-group/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/invite-users-to-project-group/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/invite-users-to-project-group/request-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/invite-users-to-project-group/http-response.adoc[]

Invite Users To Project API

Invite Users To Project API can be used to invite new or existing users to a project.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/invite-users-to-project/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/invite-users-to-project/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/invite-users-to-project/request-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/invite-users-to-project/request-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/invite-users-to-project/http-response.adoc[]

Invite Users To Organization API

Invite Users To Organization API can be used to invite new or existing users to an organization.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/invite-users-to-organization/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/invite-users-to-organization/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/invite-users-to-organization/request-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/invite-users-to-organization/request-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/invite-users-to-organization/http-response.adoc[]

Uninvite Users From Project Group API

Uninvite Users From Project Group API can be used to revoke a project group users membership.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/uninvite-users-from-project-group/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/uninvite-users-from-project-group/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/uninvite-users-from-project-group/request-parameters.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/uninvite-users-from-project-group/http-response.adoc[]

Uninvite Users From Project API

Uninvite Users From Project API can be used to revoke a project users membership.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/uninvite-users-from-project/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/uninvite-users-from-project/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/uninvite-users-from-project/request-parameters.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/uninvite-users-from-project/http-response.adoc[]

Uninvite Users From Organization API

Uninvite Users From Organization API can be used to revoke an organization users membership.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/uninvite-users-from-organization/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/uninvite-users-from-organization/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/uninvite-users-from-organization/request-parameters.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/uninvite-users-from-organization/http-response.adoc[]

Get Organization Users API

Get the list of users for a given organization.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-organization-users/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-organization-users/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-organization-users/request-parameters.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-organization-users/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-organization-users/http-response.adoc[]

Get Project Users API

Get the list of users for a given project.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-project-users/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-project-users/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-project-users/request-parameters.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-project-users/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-project-users/http-response.adoc[]

Update User’s external ID API

Update User’s external ID API is used to update an external ID of an existing user in Newmetrix.
User calling this API must have permission to manage at least one of organizations which the user belong to.
To set an external ID for the user that doesn’t have one, omit the oldId field in the request payload.
Upon successful execution the API returns response payload along with 200 response code.
For any incorrect parameters passed the response code 400 is returned.
For any permission related errors the response code 401 is returned.
If user cannot be found the response code 404 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-user-externalId/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-user-externalId/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-user-externalId/request-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-user-externalId/http-response.adoc[]

Reset User’s external ID API

Reset User’s external ID API is used to reset an external ID of an existing user in Newmetrix.
User calling this API must have permission to manage at least one of organizations which the user belong to.
Upon successful execution the API returns response payload along with 200 response code.
For any incorrect parameters passed the response code 400 is returned.
For any permission related errors the response code 401 is returned.
If user cannot be found the response code 404 is returned.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-user-externalId/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-user-externalId/path-parameters.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-user-externalId/http-response.adoc[]

Get User settings API

Get User Settings

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-user-settings/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-user-settings/path-parameters.adoc[]

response fields description

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-user-settings/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-user-settings/http-response.adoc[]

Update User settings API

Update user settings

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-user-settings/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-user-settings/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-user-settings/request-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/update-user-settings/http-response.adoc[]

Organizations and Project Groups

Retrieve project groups for an organization

Get the list of project groups for a given organization.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-project-group/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-project-group/path-parameters.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-project-group/http-response.adoc[]

Retrieve organizations for the current user

Get the list of all organizations that the current user belongs to.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-organizations/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-organizations/path-parameters.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-organizations/http-response.adoc[]

Integrations

Integration APIs are available to programmatically set up project-level integrations with 3rd parties. There are four APIs available: to create new integrations, update settings of existing integrations, get integration settings, and finally delete integrations. For each of the calls a project must be specified (using an internal ID or external ID) and an integrationType. Note: first integration must be set up manually in the User Interface to authenticate and establish an integration token for the user. Once that is done, API can be used to create subsequent integrations of that type. We recommend creating and using a designated service account for all integrations.

Get integration settings for project

Get integration settings for project, for the specified integrationType. If the project does not have the integration of the specified type set up, it returns 404 "Integration settings for projectID: projectId cannot be found"

Example request for all types of integration

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-get-integration-settings-for-sharepoint/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-get-integration-settings-for-sharepoint/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-get-integration-settings-for-sharepoint/request-parameters.adoc[]

Example response for Sharepoint

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-get-integration-settings-for-sharepoint/http-response.adoc[]

response body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-get-integration-settings-for-sharepoint/response-fields.adoc[]

Example response for Procore

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-get-integration-settings-for-procore/http-response.adoc[]

response body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-get-integration-settings-for-procore/response-fields.adoc[]

Example response for Struction Site

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-get-integration-settings-for-struction-site/http-response.adoc[]

response body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-get-integration-settings-for-struction-site/response-fields.adoc[]

Get integration settings for user

Get integration settings across all projects for a given user in organization, for the specified integration type.

Example request for all types of integration

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-get-integration-settings-for-organization/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-get-integration-settings-for-organization/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-get-integration-settings-for-organization/request-parameters.adoc[]

Example response

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-get-integration-settings-for-organization/http-response.adoc[]

response body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-get-integration-settings-for-organization/response-fields.adoc[]

Create integration settings

Create integration settings for project is used to create a new integration of the specified integrationType. It accepts internal or external project IDs. Important Note: At least one integration must be set up manually in the User Interface to authenticate and establish an token for the user. Once that is done, this API call uses the token associated with the user making this call. If the token has not been established for the user it returns 401 UnAuthorized

Example for SharePoint

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-sharepoint/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-sharepoint/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-sharepoint/request-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-sharepoint/http-response.adoc[]

response body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-sharepoint/response-fields.adoc[]

Example for Procore

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-procore/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-procore/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-procore/request-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-procore/http-response.adoc[]

response body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-procore/response-fields.adoc[]

Example for Struction Site

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-struction-site/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-struction-site/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-struction-site/request-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-struction-site/http-response.adoc[]

response body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-create-integration-settings-for-struction-site/response-fields.adoc[]

Update integration settings

This call is used to make changes to the settings of the existing integration. Note: you must first disable an integration to make changes to the parameters, and then re-enable the integration, once the desired changes have been made. If the integration is enabled no changes can happen except setting it to disabled.

Example for SharePoint

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-sharepoint/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-sharepoint/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-sharepoint/request-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-sharepoint/http-response.adoc[]

response body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-sharepoint/response-fields.adoc[]

Example for Procore

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-procore/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-procore/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-procore/request-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-procore/http-response.adoc[]

response body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-procore/response-fields.adoc[]

Example for Struction Site

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-struction-site/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-struction-site/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-struction-site/request-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-struction-site/http-response.adoc[]

response body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-update-integration-settings-for-struction-site/response-fields.adoc[]

Delete integration settings

Use this call to delete an existing integration.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-delete-integration-settings-for-sharepoint/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-delete-integration-settings-for-sharepoint/path-parameters.adoc[]

request parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-delete-integration-settings-for-sharepoint/request-parameters.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/public-api-delete-integration-settings-for-sharepoint/http-response.adoc[]

Reporting

Schedule/run photo report for the project

Schedule photo report to be emailed to a set of users for photos with the defined set of tags. Multiple photo reports can be scheduled per project with various sets of users, tags and other settings.

Calling this API with reportFixedScheduleInterval set to NEVER will generate a one-time report instead of scheduling it to be generated periodically.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/schedule-photo-report/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/schedule-photo-report/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/schedule-photo-report/request-fields.adoc[]

Schedule/run photo report for the project on behalf of a user

Only organization admins can call this API

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/schedule-photo-report-on-behalf-of-user/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/schedule-photo-report-on-behalf-of-user/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/schedule-photo-report-on-behalf-of-user/request-fields.adoc[]

Get the list of scheduled photo reports for the project

Retrieve the list of scheduled photo reports and their settings for a given project.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-reports/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-reports/path-parameters.adoc[]

request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-reports/response-fields.adoc[]

sample response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/get-reports/http-response.adoc[]

Remove scheduled photo report

Remove scheduled photo report for the project. This API only removes one scheduled photo report. Other scheduled photo reports are not changed.

request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-photo-report/http-request.adoc[]

path parameters

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/delete-photo-report/path-parameters.adoc[]

Metrics

The following metrics are currently available:

Table 1. List of supported metrics
Metric Name Description

Activity Metrics

ASSET_UPLOAD_COUNT

Count of assets uploaded, by type

ASSET_CREATED_COUNT

Count of assets created, by type

AVG_UPLOAD_PER_DAY

Average number of uploads per day

TAG_INSTANCE_CREATION_COUNT

Number of tags created, by type

UPLOADER_USER_COUNT

Number of unique users who uploaded assets

ACTIVE_USER_COUNT

Number of active users

INTEGRATION_CREATED_COUNT

Number of assets created via integration(s), by content source type

USER_CREATED_COUNT

Number of assets created via direct uploads from WWW/mobile or public API, by content source type

INTEGRATION_UPLOADER_EXTERNAL_USER_COUNT

Count of unique integration system user ids who have uploaded assets through different sources of integrations per integration type

INTEGRATION_EXTERNAL_USER_ASSET_CREATED_COUNT

Count of assets created by integration system users

USER_ASSET_CREATED_COUNT

Count of assets created by users

USER_TAG_INSTANCE_CREATION_COUNT

Number of tags created by user, by type

USER_COMMENT_COUNT

Number of comments created by user

Safety Metrics

CONSTRUCTION_ASSET_COUNT

Count of assets with tag "Construction"

CONSTRUCTION_PHOTO_COUNT

Count of photos with tag "Construction"

CONSTRUCTION_TO_TOTAL_ASSET_RATIO

Count of Images with tag "Construction" / Total Assets

BULLDOZER_COUNT

Count of equipment type: bulldozer

PICKUP_TRUCK_COUNT

Count of equipment type: pickup truck

BOX_TRUCK_COUNT

Count of equipment type: box truck

FRONT_END_LOADER_COUNT

Count of equipment type: front end loader

BACKHOE_COUNT

Count of equipment type: backhoe

CONCRETE_MIXER_COUNT

Count of equipment type: concrete mixer

CONCRETE_PUMP_COUNT

Count of equipment type: concrete pump

DRILL_COUNT

Count of equipment type: drill

MOBILE_CRANE_COUNT

Count of equipment type: mobile crane

EXCAVATOR_COUNT

Count of equipment type: excavator

ALL_LADDERS_COUNT

Count of assets tagged with "Ladder", "Folding Ladder", "Extension Ladder", "Site Ladder", "Platform Ladder", "Access Platform"

LADDER_COUNT

Count of assets tagged with "Ladder"

FOLDING_LADDER_COUNT

Count of Folding Ladders

EXTENSION_LADDER_COUNT

Count of Extension Ladders

SITE_LADDER_COUNT

Count of Site Ladders

PLATFORM_LADDER_COUNT

Count of Platform Ladders

ACCESS_PLATFORM_COUNT

Count of Access Platforms

ALL_LIFTS_COUNT

Count of assets tagged with "Boom Lift", "Scissor Lift"

BOOM_LIFT_COUNT

Count of Boom lifts

SCISSOR_LIFT_COUNT

Count of Scissor lifts

SCAFFOLDING_COUNT

Count of Scaffolding

STAIRWAY_COUNT

Count of Stairway

EXPOSED_HOLE_COUNT

Count of Exposed hole

SOCIAL_DISTANCE_COMPLIANCE

Social Distance compliance

WAH_PER_HUNDRED_CONSTRUCTION

Count of Work at Height per 100 construction photos

LADDER_TO_LIFT_RATIO

Ladder-to-Lift Ratio

HOUSEKEEPING_AND_STANDING_WATER_PER_HUNDRED_CONSTRUCTION

Count of Housekeeping & Standing Water per 100 construction photos

HOUSEKEEPING_PER_HUNDRED_CONSTRUCTION

Count of Housekeeping per 100 construction photos

HOUSEKEEPING_COUNT

Count of assets tagged with “Housekeeping”

HOUSEKEEPING_AND_STANDING_WATER_COUNT

Count of assets tagged with “Housekeeping” or “Standing Water”

STANDING_WATER_PER_HUNDRED_CONSTRUCTION

Count of Standing Water per 100 construction photos

STANDING_WATER_COUNT

Count of assets tagged with “Standing Water”

PERSONS_PER_HUNDRED_CONSTRUCTION

Count of Persons per 100 construction photos

AVERAGE_PPE

Average PPE Compliance

PERSON_COUNT

Count of assets tagged with "Person"

PPE_INCIDENT_COUNT

Count of assets tagged with "No Glasses", "No Gloves", "No Hard Hat", "No Hi-Vis", "No Face Mask"

GLASSES_COMPLIANCE

Glasses Compliance (values 0-1)

GLOVE_COMPLIANCE

Gloves Compliance (values 0-1)

GLOVES_COMPLIANCE_FOR_PEOPLE_IN_GROUP

Gloves compliance for People in Group

HARD_HAT_COMPLIANCE

Hard Hat Compliance (values 0-1)

HI_VIS_COMPLIANCE

Hi-Vis Compliance (values 0-1)

GLASSES_INCIDENT_COUNT

Count of assets tagged with "No Glasses"

GLOVE_INCIDENT_COUNT

Count of assets tagged with "No Gloves"

HARD_HAT_INCIDENT_COUNT

Count of assets tagged with "No Hard Hat"

HI_VIS_INCIDENT_COUNT

Count of assets tagged with "No Hi-Vis"

AVG_CREATED_PER_DAY

Average number of assets created per day

AVG_CREATED_BY_DAY_OF_WEEK

Average number of assets created by day of week

AVG_DIFFERENCE_CREATED_UPLOADED

Average lag of uploading

PERCENT_OF_ASSETS_WITH_NO_CREATED_DATE

Percentage of photos with no created date

PERCENT_OF_CONSTRUCTION_ASSETS_WITH_NO_CREATED_DATE

Percentage of construction photos with no created date

PERSON_COVERAGE_PERCENT

Percentage of photos with people

PERCENT_FIT_OUT

Percentage of fit-out photos

PERCENT_FINISH_DETAIL

Percentage of Finish Detail photos

CONSTRUCTION_ACTIVITY_COUNT

Count of photos with Construction Activity tags in them

PROJECT_SCORE

Project’s overall weighted safety score as compared to other projects in organization

PERCENT_OF_PEOPLE_IN_GROUP

Percentage of assets with "Person in Group" tag

PEOPLE_IN_GROUP_COUNT

Count of assets with "Person in Group" tag

PERSON_AT_HEIGHT_PER_HUNDRED_CONSTRUCTION

Count of "person at height" tags per 100 construction photos

FACE_MASK_INCIDENT_COUNT

Count of instances without face mask

ASSETS_WITH_PEOPLE_COUNT

Count of images with people in them

FACE_MASK_COMPLIANCE

Face mask Compliance

FACE_MASK_COMPLIANCE_FOR_PEOPLE_IN_GROUP

Face mask compliance for People in Group

ACUTE_IBP_COUNT

Count of Acute IBP incidents

CHRONIC_IBP_COUNT

Count of Chronic IBP incidents

LADDER_USE_ISSUE_COUNT

Count of ladder use issues

SCAFFOLDING_ISSUE_COUNT

Count of tag "Guardrail Issue" - across all photos (including oxblue/truelook), regardless of confidence or Construction Tag

FALL_ARREST_COUNT

Count of tag "Fall Arrest Issue" - across all photos (including oxblue/truelook), regardless of confidence or Construction Tag

GUARDRAIL_ISSUE_COUNT

Count of tag "Guardrail Issue" - across all photos (including oxblue/truelook), regardless of confidence or Construction Tag

LADDER_SETUP_ISSUE_COUNT

Count of ladder setup issues

MEPI_ISSUE_COUNT

Count of MEPI issues

IMPALEMENT_HAZARD_COUNT

Count of impalement hazards

TRENCH_ISSUE_COUNT

Count of trench issues

STRUCTURAL_STEEL_COUNT

Count of assets tagged with “Structural Steel”

STRUCTURAL_STEEL_PER_HUNDRED_CONSTRUCTION

Count of “Structural Steel” per 100 construction photos

PERSON_AT_HEIGHT_COUNT

Count of assets tagged with “Person at Height”

UNSECURED_WORKER_AT_HEIGHT_COUNT

Count of assets tagged with “Unsecured Worker At Height”

UNSECURED_WORKER_AT_HEIGHT_PER_HUNDRED_CONSTRUCTION

Count of “Unsecured Worker At Height” per 100 construction photos

DUMPSTER_FULL_COUNT

Count of assets tagged with “Dumpster Full”

TRASH_BIN_FULL_COUNT

Count of assets tagged with “Trash Bin Full”

DUMPSTER_COUNT

Count of assets tagged with “Dumpster”

TRASH_BIN_COUNT

Count of assets tagged with “Trash Bin”

Observation Metrics

OBSERVATION_COUNT_TOTAL

Count of total observations

OBSERVATION_COUNT_BY_TYPE

Count of observations by type (POSITIVE, RISK)

OBSERVATION_POSITIVE_TO_RISK_RATIO

Positive-to-Risk Observation Ratio

OBSERVATION_RISK_COUNT_BY_HAZARD_CATEGORY

Count of risk observations by Hazard Category

OBSERVATION_POSITIVE_COUNT_BY_HAZARD_CATEGORY

Count of positive observations by Hazard Category

OBSERVATION_RISK_COUNT_BY_IDENTIFICATION_METHOD

Count of risk observations by Identification Method

OBSERVATION_POSITIVE_COUNT_BY_IDENTIFICATION_METHOD

Count of positive observations by Identification Method

OBSERVATION_RISK_COUNT_BY_RISK_BAND

Count of risk observations by Risk Band

OBSERVATION_RISK_COUNT_OPEN_BY_RISK_BAND

Count of currently open observations of type "Risk", grouped by Risk band (very similar to OBSERVATION_RISK_COUNT_OPEN_BY_STATUS)

OBSERVATION_RISK_COUNT_CLOSED_BY_RISK_BAND

Count of currently closed observations of type "Risk", grouped by Risk band (very similar to OBSERVATION_RISK_COUNT_OPEN_BY_RISK_BAND)

OBSERVATION_RISK_COUNT_BY_RISK_SCORE

Count of risk observations by Risk Score (1 - 25)

OBSERVATION_RISK_AVERAGE_RISK_SCORE

Average Risk Score for risk observations

OBSERVATION_RISK_MAXIMUM_RISK_SCORE

Maximum Risk Score for risk observations

OBSERVATION_GREAT_CATCH_COUNT_TOTAL

Count of the total number of observations marked as Great Catch

OBSERVATION_GREAT_CATCH_COUNT_BY_TYPE

Count of observations by type (POSITIVE, RISK) marked as Great Catch

OBSERVATION_RISK_GREAT_CATCH_AVERAGE_RISK_SCORE

Average Risk Score for risk observations marked as Great Catch

OBSERVATION_COUNT_OPEN_BY_TYPE

Count of open observations by type (POSITIVE, RISK)

OBSERVATION_COUNT_CLOSED_BY_TYPE

Count of closed observations by type (POSITIVE, RISK)

OBSERVATION_RISK_COUNT_OPEN_BY_STATUS

Count of risk observations by status

OBSERVATION_POSITIVE_COUNT_OPEN_BY_STATUS

Count of positive observations by status

OBSERVATION_RISK_AVERAGE_DAYS_OPEN

Number of average days open - for risk observations

OBSERVATION_RISK_AVERAGE_DAYS_OPEN_BY_RISK_BAND

Number of average days open by Risk Band - for risk observations

OBSERVATION_RISK_AVERAGE_DAYS_IT_TOOK_TO_CLOSE

Number of average days it took to close a risk observation opened in a non-Closed state

OBSERVATION_RISK_AVERAGE_DAYS_IT_TOOK_TO_CLOSE_BY_RISK_BAND

Number of average days it took to close a risk observation opened in a non-Closed state grouped by risk band

OBSERVATION_RISK_COUNT_PAST_DUE

Count of past due observations - for risk observations

OBSERVATION_RISK_COUNT_PAST_DUE_BY_RISK_BAND

Count of past due observations - for risk observations, grouped by risk band

OBSERVATION_RISK_AVERAGE_DAYS_LATENESS_FOR_PAST_DUE

Average lateness in days for past due observations - for risk observations

OBSERVATION_RISK_AVERAGE_DAYS_LATENESS_FOR_PAST_DUE_BY_RISK_BAND

Average lateness in days for past due observations - for risk observations, grouped by risk band

OBSERVATION_COUNT_BY_CREATOR

Count of observations by its creator

OBSERVATION_COUNT_BY_CREATOR_AND_TYPE

Count of observations by its creator by observation types (POSITIVE, RISK)

OBSERVATION_COUNT_OF_UNIQUE_CREATORS

Count of unique observation creators

OBSERVATION_COUNT_OF_UNIQUE_ASSIGNEES

Count of unique observation assignees

Get Metrics API

Returns a batch of metrics data. The API enables you to get multiple metric types and date ranges in a single request.

HTTP request

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/metrics-get-batch/http-request.adoc[]

The request body contains data with the following structure:

Request body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/metrics-get-batch/request-fields.adoc[]

HTTP response

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/metrics-get-batch/http-response.adoc[]

If successful, the response body contains data with the following structure:

Response body

Unresolved directive in api-guide.adoc - include::/scratch/workspace/hotfix-microservices/SmartvidMicroservice/target/generated-snippets/metrics-get-batch/response-fields.adoc[]

Not all object types and metrics can be requested together. Refer to the following table for object types, details, and time periods corresponding to which metrics.

Table 2. Metrics Details
Metric Name Object Types Time Frames Details

Activity Metrics

ASSET_UPLOAD_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

TOTAL, VIDEO, IMAGE IMAGE_AUDIO, SPHERICAL_IMAGE, OTHER

ASSET_CREATED_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

TOTAL, VIDEO, IMAGE IMAGE_AUDIO, SPHERICAL_IMAGE, OTHER

AVG_UPLOAD_PER_DAY

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

TAG_INSTANCE_CREATION_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

TOTAL, MANUAL, ASR, IMREC, INTEGRATION

UPLOADER_USER_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

ACTIVE_USER_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

INTEGRATION_CREATED_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

TOTAL, UNKNOWN, WWW, ANDROID, IOS, API

USER_CREATED_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

TOTAL, UNKNOWN, WWW, ANDROID, IOS, API

INTEGRATION_UPLOADER_EXTERNAL_USER_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

TOTAL, PROCORE, BIM360_FIELD, EGNYTE, FORGE, FORGE_ISSUE, FORGE_CHECKLIST_INSTANCE, FORGE_ISSUE_CREATED, OXBLUE, BOX, ACONEX

INTEGRATION_EXTERNAL_USER_ASSET_CREATED_COUNT

PROJECT_USER_METRIC,
PROJECT_GROUP_USER_METRIC,
ORGANIZATION_USER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

TOTAL, PROCORE, BIM360_FIELD, EGNYTE, FORGE, FORGE_ISSUE, FORGE_CHECKLIST_INSTANCE, FORGE_ISSUE_CREATED, OXBLUE, BOX, ACONEX

USER_ASSET_CREATED_COUNT

PROJECT_USER_METRIC,
PROJECT_GROUP_USER_METRIC,
ORGANIZATION_USER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

TOTAL, VIDEO, IMAGE IMAGE_AUDIO, SPHERICAL_IMAGE, OTHER

USER_TAG_INSTANCE_CREATION_COUNT

PROJECT_USER_METRIC,
PROJECT_GROUP_USER_METRIC,
ORGANIZATION_USER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

TOTAL, MANUAL, ASR, IMREC, INTEGRATION

USER_COMMENT_COUNT

PROJECT_USER_METRIC,
PROJECT_GROUP_USER_METRIC,
ORGANIZATION_USER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

AVG_CREATED_PER_DAY

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

AVG_CREATED_BY_DAY_OF_WEEK

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

AVG_DIFFERENCE_CREATED_UPLOADED

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

PERCENT_OF_ASSETS_WITH_NO_CREATED_DATE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

PERCENT_OF_CONSTRUCTION_ASSETS_WITH_NO_CREATED_DATE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

Safety Metrics

CONSTRUCTION_ASSET_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

CONSTRUCTION_PHOTO_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

CONSTRUCTION_TO_TOTAL_ASSET_RATIO

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

BULLDOZER_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

PICKUP_TRUCK_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

BOX_TRUCK_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

FRONT_END_LOADER_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

BACKHOE_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

CONCRETE_MIXER_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

CONCRETE_PUMP_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

DRILL_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

MOBILE_CRANE_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

EXCAVATOR_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

ALL_LADDERS_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

LADDER_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

FOLDING_LADDER_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

EXTENSION_LADDER_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

SITE_LADDER_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

PLATFORM_LADDER_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

ACCESS_PLATFORM_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

ALL_LIFTS_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

BOOM_LIFT_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

SCISSOR_LIFT_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

SCAFFOLDING_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

STAIRWAY_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

EXPOSED_HOLE_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

SOCIAL_DISTANCE_COMPLIANCE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

WAH_PER_HUNDRED_CONSTRUCTION

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

LADDER_TO_LIFT_RATIO

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

HOUSEKEEPING_AND_STANDING_WATER_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

HOUSEKEEPING_AND_STANDING_WATER_PER_HUNDRED_CONSTRUCTION

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

HOUSEKEEPING_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

HOUSEKEEPING_PER_HUNDRED_CONSTRUCTION

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

STANDING_WATER_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

STANDING_WATER_PER_HUNDRED_CONSTRUCTION

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

PERSONS_PER_HUNDRED_CONSTRUCTION

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

AVERAGE_PPE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

PERSON_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

PPE_INCIDENT_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

GLASSES_COMPLIANCE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

GLOVE_COMPLIANCE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

GLOVES_COMPLIANCE_FOR_PEOPLE_IN_GROUP

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

HARD_HAT_COMPLIANCE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

HI_VIS_COMPLIANCE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

FACE_MASK_COMPLIANCE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

FACE_MASK_COMPLIANCE_FOR_PEOPLE_IN_GROUP

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

FACE_MASK_INCIDENT_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

ASSETS_WITH_PEOPLE_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

GLASSES_INCIDENT_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

GLOVE_INCIDENT_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

HARD_HAT_INCIDENT_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

HI_VIS_INCIDENT_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

PERSON_COVERAGE_PERCENT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

PERCENT_FIT_OUT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

PERCENT_FINISH_DETAIL

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

CONSTRUCTION_ACTIVITY_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

CONCRETE_POUR, DEMOLITION, EXCAVATION, FOUNDATION, MEP, TRENCH_WORK

PROJECT_SCORE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

PERCENT_OF_PEOPLE_IN_GROUP

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

PEOPLE_IN_GROUP_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

PERSON_AT_HEIGHT_PER_HUNDRED_CONSTRUCTION

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

ACUTE_IBP_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

CHRONIC_IBP_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

LADDER_USE_ISSUE_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

GUARDRAIL_ISSUE_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

FALL_ARREST_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

SCAFFOLDING_ISSUE_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

LADDER_SETUP_ISSUE_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

MEPI_ISSUE_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

IMPALEMENT_HAZARD_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

TRENCH_ISSUE_COUNT

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

Observation Metrics

OBSERVATION_COUNT_TOTAL

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_COUNT_BY_TYPE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

POSITIVE, NEGATIVE

OBSERVATION_POSITIVE_TO_RISK_RATIO

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_RISK_COUNT_BY_HAZARD_CATEGORY

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_POSITIVE_COUNT_BY_HAZARD_CATEGORY

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_RISK_COUNT_BY_IDENTIFICATION_METHOD

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_POSITIVE_COUNT_BY_IDENTIFICATION_METHOD

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_RISK_COUNT_OPEN_BY_RISK_BAND

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

POSITIVE, EXTREME, HIGH, MEDIUM, LOW, UNKNOWN, RISK

OBSERVATION_RISK_COUNT_CLOSED_BY_RISK_BAND

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

POSITIVE, EXTREME, HIGH, MEDIUM, LOW, UNKNOWN, RISK

OBSERVATION_RISK_COUNT_BY_RISK_BAND

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

POSITIVE, EXTREME, HIGH, MEDIUM, LOW, UNKNOWN, RISK

OBSERVATION_RISK_COUNT_BY_RISK_SCORE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_RISK_AVERAGE_RISK_SCORE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_RISK_MAXIMUM_RISK_SCORE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_GREAT_CATCH_COUNT_TOTAL

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_GREAT_CATCH_COUNT_BY_TYPE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

POSITIVE, NEGATIVE

OBSERVATION_RISK_GREAT_CATCH_AVERAGE_RISK_SCORE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_COUNT_OPEN_BY_TYPE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

POSITIVE, NEGATIVE

OBSERVATION_COUNT_CLOSED_BY_TYPE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

POSITIVE, NEGATIVE

OBSERVATION_RISK_COUNT_OPEN_BY_STATUS

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

NEW, IN_PROGRESS, WITH_PARTNER, DELAYED, CLOSED, READY_TO_REVIEW, CLOSED_REVIEWED, OBSERVED, NOT_APPLICABLE

OBSERVATION_POSITIVE_COUNT_OPEN_BY_STATUS

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

NEW, IN_PROGRESS, WITH_PARTNER, DELAYED, CLOSED, READY_TO_REVIEW, CLOSED_REVIEWED, OBSERVED, NOT_APPLICABLE

OBSERVATION_RISK_AVERAGE_DAYS_OPEN

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_RISK_AVERAGE_DAYS_OPEN_BY_RISK_BAND

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

POSITIVE, EXTREME, HIGH, MEDIUM, LOW, UNKNOWN, RISK

OBSERVATION_RISK_AVERAGE_DAYS_IT_TOOK_TO_CLOSE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_RISK_AVERAGE_DAYS_IT_TOOK_TO_CLOSE_BY_RISK_BAND

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

POSITIVE, EXTREME, HIGH, MEDIUM, LOW, UNKNOWN, RISK

OBSERVATION_RISK_COUNT_PAST_DUE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_RISK_COUNT_PAST_DUE_BY_RISK_BAND

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

POSITIVE, EXTREME, HIGH, MEDIUM, LOW, UNKNOWN, RISK

OBSERVATION_RISK_AVERAGE_DAYS_LATENESS_FOR_PAST_DUE

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_RISK_AVERAGE_DAYS_LATENESS_FOR_PAST_DUE_BY_RISK_BAND

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

POSITIVE, EXTREME, HIGH, MEDIUM, LOW, UNKNOWN, RISK

OBSERVATION_COUNT_BY_CREATOR

PROJECT_USER_METRIC,
PROJECT_GROUP_USER_METRIC,
ORGANIZATION_USER_METRIC,
TRADE_PARTNER_USER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_COUNT_BY_CREATOR_AND_TYPE

PROJECT_USER_METRIC,
PROJECT_GROUP_USER_METRIC,
ORGANIZATION_USER_METRIC,
TRADE_PARTNER_USER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

POSITIVE, NEGATIVE

OBSERVATION_COUNT_OF_UNIQUE_CREATORS

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH

OBSERVATION_COUNT_OF_UNIQUE_ASSIGNEES

PROJECT_METRIC,
PROJECT_GROUP_METRIC,
ORGANIZATION_METRIC,
TRADE_PARTNER_METRIC,
PROJECT_TRADE_PARTNER_METRIC,
PROJECT_GROUP_TRADE_PARTNER_METRIC,
ORGANIZATION_TRADE_PARTNER_METRIC

LAST_1, LAST_7, LAST_30, LAST_60, LAST_90, WEEK_TO_DATE, MONTH_TO_DATE, CALENDAR_MONTH