| Method | HTTP request | Description |
|---|---|---|
| getStructuredTarget | GET /structured_targets/ | Get Structured Target |
| getStructuredTargets | GET /structured_targets | Get Structured Targets |
getStructuredTarget
GetStructuredTargetResponse getStructuredTarget()Endpoint for getting data about a specific structured target by its ID.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| structuredTargetId | [string] | Structured target ID | defaults to undefined |
Return type
GetStructuredTargetResponseAuthorization
No authorization requiredHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Structured target retrieved successfully | - |
| 401 | Unauthorized | - |
| 404 | Not found | - |
| 500 | Internal server error | - |
getStructuredTargets
GetStructuredTargetsResponse getStructuredTargets()Page size (min: 1, max: 2000)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| type | [string] | Filter by structured target type | (optional) defaults to undefined |
| competition | [string] | Filter by competition | (optional) defaults to undefined |
| pageSize | [number] | Number of items per page (min 1, max 2000, default 100) | (optional) defaults to 100 |
| cursor | [string] | Pagination cursor | (optional) defaults to undefined |
Return type
GetStructuredTargetsResponseAuthorization
No authorization requiredHTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Structured targets retrieved successfully | - |
| 401 | Unauthorized | - |
| 500 | Internal server error | - |