Skip to main content

Creating Monitoring Periods

A monitoring period defines the timeframe your project will be audited against. Each monitoring period has:

  • A start date and end date defining the period
  • An association with a specific Facility
  • Optional description for additional context

Listing Monitoring Periods​

To view existing monitoring periods, use the GET /v0/monitoring-periods endpoint:

Get monitoring periods
curl -X 'GET' "/v0/monitoring-periods" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $BEARER"

Response Schema​

id
required
string
description
required
string or null
startDate
required
string <date-time>
endDate
required
string <date-time>
facilityId
required
string

Creating a Monitoring Period​

To create a new monitoring period, use the POST /v0/monitoring-periods endpoint:

Create monitoring period
curl -X 'POST' "/v0/monitoring-periods" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $BEARER" \
  -d '{ \
    "facilityId": "facility-uuid-here", \
    "startDate": "2026-01-01T00:00:00Z", \
    "endDate": "2026-01-31T23:59:59Z", \
    "description": "2026 January Monitoring Period" \
  }'

Getting a Specific Monitoring Period​

To retrieve details about the created monitoring period, you can use the GET /v0/monitoring-periods/{id} endpoint:

Get monitoring period
curl -X 'GET' "/v0/monitoring-periods/{id}" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $BEARER"

Updating a Monitoring Period​

The details of a monitoring period can be updated using PATCH /v0/monitoring-periods/{id}.

Duplicating a Monitoring Period​

If you want to re-use the setup from a previous Monitoring Period, you can duplicate an existing one using the duplicate endpoint. Consider duplication, when using a workflow where you prefer setting up the Monitoring Period customizations only once. The other option is to programmatically create the customizations for each Monitoring Period separately, which might suit your integration better.

Duplicate monitoring period
curl -X 'POST' "/v0/monitoring-periods/{id}/duplicate" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $BEARER" \
  -d '{ \
    "targetFacilityId": "new-facility-uuid", \
    "startDate": "2025-01-01T00:00:00Z", \
    "endDate": "2025-12-31T23:59:59Z" \
  }'

This will copy the monitoring period's configuration including Frameworks, Documents, Models, and their customizations to the new Monitoring Period.

Deleting a Monitoring Period​

To delete a monitoring period, use DELETE /v0/monitoring-periods/{id}:

Delete monitoring period
curl -X 'DELETE' "/v0/monitoring-periods/{id}" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $BEARER"
Deletion Warning

Deleting a monitoring period will also delete all associated data including frameworks, documents, evidence requests, and field values. This action cannot be undone.

Next Steps​

Once you have created a new monitoring period, move on to the next page to attach Frameworks to the period to apply Methodology specific compliance requirements for it.