Documentation Index
Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt
Use this file to discover all available pages before exploring further.
Services
RPC methods exposed by this API.
UnitService
Messages
Data models used across requests/responses.
CreateUnitRequest
| Field | Type | Label | Description |
|---|
| name | string | | |
CreateUnitResponse
| Field | Type | Label | Description |
|---|
| unit | Unit | | |
ListUnitsRequest
| Field | Type | Label | Description |
|---|
| page_size | uint32 | | The maximum number of units to return. The service may return fewer than this value. If unspecified, at most 50 units will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| page_token | string | | A page token, received from a previous ListUnits call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUnits must match the call that provided the page token. |
| filter | string | | A Common Expression Language (CEL, https://github.com/google/cel-spec) filter string. Available tag variables are: - abbreviated_name - name - created_date - unit_id |
| order_by | string | | How to order the retrieved campaigns. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are name, created_date, and abbreviated_name. If left empty, items are ordered by created_date in ascending order (oldest-first). For more information about the format of this field, read this Example: “created_date desc,abbreviated_name” |
ListUnitsResponse
| Field | Type | Label | Description |
|---|
| units | Unit | repeated | |
| next_page_token | string | | A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages. |
Unit
| Field | Type | Label | Description |
|---|
| unit_id | string | | |
| abbreviated_name | string | | |
Enums
Allowed constant values used in message fields.
