Relationships
The Relationships API field provides information on how the current resource is associated with other resources in the API. This field appears in API responses and lets you navigate between related data objects. It contains an array of relationship objects, each with the following structure:
| Field name | Description |
|---|---|
Id |
The unique identifier of the related resource. |
Type |
The resource type of the related object. For example, Monitor and MonitorCheck. |
Links |
Contains URLs to related resources that are associated with the current object. This contains Self that is the direct API endpoint URL to access the related resource. For example, /Monitor/6f426452-5d2b-4fdf-84e2-c2b3d7ebf918 can be used in a GET request to retrieve that specific monitor’s data. |
API Response
When you retrieve data from the API, the response includes a Relationships field showing the associated monitor:
{
...
"Relationships": [
{
"Id": "6f426452-5d2b-4fdf-84e2-c2b3d7ebf918",
"Type": "Monitor",
"Links": {
"Self": "/Monitor/6f426452-5d2b-4fdf-84e2-c2b3d7ebf918"
}
}
]
}
Using relationships
To retrieve the related monitor data, use the URL from Links.Self in a new API request:
GET https://api.uptrends.com/v4/Monitor/6f426452-5d2b-4fdf-84e2-c2b3d7ebf918
This returns the full monitor configuration and details associated with the original data.