Search Statement Data
GET/api/v1/search
Search for Statement Data across all fields
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| text_search | string | No | Text string to globally search across all fields |
| filters | array | No | Array of filter objects. See Filters Reference for details. |
| pagesize | integer | No | Number of results per page |
| page | integer | No | Page number for pagination |
| include_rules | boolean | No | Optionally include rule information for tag fields |
Autocomplete
GET/api/v1/autocomplete
Retrieve distinct values for a specified field with optional text search.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| field | string | Yes | The field to retrieve distinct values for. |
| text_search | string | No | Text string to filter values (must be at least 3 characters if provided). |
| pagesize | integer | No | Number of results per page (default is 10, max is 1000). |
| page | integer | No | Page number for pagination (default is 0). |
| count | boolean | No | Whether to return the record counts for each distinct value. |
| sort_by_count | boolean | No | Return sorted by record count if true, alphabetical if false. |
Search Statements
GET/api/v1/statements
Search and retrieve a list of statements based on specified criteria.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| text_search | string | No | Text string to search across all fields |
| carrier | array | No | Array of carrier names to filter by |
| statement_date_start | string | No | Start date for statement date range (YYYY-MM-DD) |
| statement_date_end | string | No | End date for statement date range (YYYY-MM-DD) |
| upload_date_start | string | No | Start date for upload date range (YYYY-MM-DD) |
| upload_date_end | string | No | End date for upload date range (YYYY-MM-DD) |
| pagesize | integer | No | Number of results per page |
| page | integer | No | Page number for pagination |
Initiate Export
POST/api/v1/exports/initiate
Initiate an export process for statement data.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| filters | array | Yes | Array of filter objects to specify data to export. |
| export_format | string | Yes | Format of the export file (e.g., CSV, JSON). |
Check Export Status
GET/api/v1/exports/status/{export_id}
Check the status of an export process.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| export_id | string | Yes | ID of the export to check status for. |
Download Export
GET/api/v1/exports/download/{export_id}
Download the export file once it is ready.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| export_id | string | Yes | ID of the export to download. |