Expandable Objects

Some responses include the ID of a related object instead of the full object. For example, an incident references the IDs of its alerts. When an object is expandable, you can ask BigPanda to inline the full related object in the response.

Append the expand query parameter to the request URL, naming the field you want to expand. For example, expand the alerts on an incident:

GET /incidents/{id}?expand=alerts

Discover what you can expand

Expandable objects are noted in the API reference for each endpoint. You can also find the identifiers for each expandable object by checking the expand property in the parent object.

Next steps

Pagination: Combine expansion with paging on list endpoints.

Responses: Read the expanded response body.

BPQL object syntax: Filter which objects you retrieve.

Expand a related object#

Discover what you can expand#

Next steps#

Expand a related object

Discover what you can expand

Next steps