| Method | HTTP request | Description |
|---|---|---|
| get_structured_target | GET /structured_targets/ | Get Structured Target |
| get_structured_targets | GET /structured_targets | Get Structured Targets |
get_structured_target
GetStructuredTargetResponse get_structured_target(structured_target_id)Get Structured Target Endpoint for getting data about a specific structured target by its ID.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| structured_target_id | str | Structured target ID |
Return type
GetStructuredTargetResponseHTTP response details
| Status code | Description |
|---|---|
| 200 | Structured target retrieved successfully |
| 401 | Unauthorized |
| 404 | Not found |
| 500 | Internal server error |
get_structured_targets
GetStructuredTargetsResponse get_structured_targets(type=type, competition=competition, page_size=page_size, cursor=cursor)Get Structured Targets Page size (min: 1, max: 2000)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| type | str | Filter by structured target type | [optional] |
| competition | str | Filter by competition | [optional] |
| page_size | int | Number of items per page (min 1, max 2000, default 100) | [optional] [default to 100] |
| cursor | str | Pagination cursor | [optional] |
Return type
GetStructuredTargetsResponseHTTP response details
| Status code | Description |
|---|---|
| 200 | Structured targets retrieved successfully |
| 401 | Unauthorized |
| 500 | Internal server error |