Skip to main content
GET
/
api
/
v1
/
sov
/
activity
List SOV Activity
curl --request GET \
  --url https://api.sovfixer.com/api/v1/sov/activity \
  --header 'Authorization: <api-key>'
{
  "results": [
    {
      "id": "<string>",
      "sovid": "<string>",
      "record_type": "ORIG",
      "completed_time": "2023-11-07T05:31:56Z",
      "pingid": "<string>",
      "revision": 123,
      "status": "<string>",
      "client_ref": "<string>",
      "incremental": false
    }
  ],
  "cursor_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

​
company__short_name
string[]

Optional filter for companies.

Minimum string length: 1
​
completed_time__gt
string<date-time>

Optional. Filter for completed_time greater than. All timestamps are UTC. It should be formatted like %Y%m%d%H%M%S. E.g. Jan 1 2023 1:00 PM would be given as 20230101130000.

​
completed_time__gte
string<date-time>

Optional. Filter for completed_time greater than or equal to. All timestamps are UTC. It should be formatted like %Y%m%d%H%M%S. E.g. Jan 1 2023 1:00 PM would be given as 20230101130000.

​
completed_time__lt
string<date-time>

Optional. Filter for completed_time less than. All timestamps are UTC. It should be formatted like %Y%m%d%H%M%S. E.g. Jan 1 2023 1:00 PM would be given as 20230101130000.

​
completed_time__lte
string<date-time>

Optional. Filter for completed_time less than or equal to. All timestamps are UTC. It should be formatted like %Y%m%d%H%M%S. E.g. Jan 1 2023 1:00 PM would be given as 20230101130000.

​
cursor_id
string

Optional. When this parameter is set from the cursor_id provided in a previous response, the page of results will start with the next item.

Minimum string length: 1
​
division__short_name
string[]

Optional filter for divisions.

Minimum string length: 1
​
fields
enum<string>[]

Optional. List of field names to include on each result.

Available options:
additional_filenames,
all_updates,
client_ref,
company__short_name,
completed_time,
created_time,
data_readiness_notes,
data_readiness_score,
division__short_name,
document_type,
extra_data,
filename,
from_email,
global_request_id,
id,
input_data,
input_file_url,
last_health_status,
latest_revision,
num_buildings,
origin,
original_file_md5_checksum,
original_sov_excel_sha256_checksum,
output_data,
parsing_completed_time,
pct_complete,
ping_certified_id,
ping_maps,
ping_maps_url,
pingdata_stats,
primary_naics_code,
progress_started_time,
risk_summary,
sov_type,
sov_type_display,
status,
status_display,
subject,
team__name,
to_email,
updates
​
id
string

Optional filter for sovid.

Minimum string length: 1
​
origin
enum<string>[]

Optional filter for origins.

  • api - api
  • email - email
Available options:
api,
email
​
page_size
integer
default:50

Optional. The maximum number of results returned in a page.

Required range: 1 <= x <= 250
​
prev_cursor_id
string

Optional. When this parameter is set from the prev_cursor_id provided in a previous response, it will provide the previous page of results.

Minimum string length: 1
​
readiness
number<double>

Optional filter for data readiness equal to than.

​
readiness__gt
number<double>

Optional filter for data readiness greater than.

​
readiness__lt
number<double>

Optional filter for data readiness less than.

​
search
string

Optional. Global search substring. Case insensitive.

Minimum string length: 1
​
status
string

Optional filter for status.

Minimum string length: 1

Response

Successful response with a list of SOV activities.

​
results
object[]
required

Up to page_size number of SOV records, sorted in ascending order, after the start timestamp, beginning with the cursor_id.

​
cursor_id
string

The last SOV or SUD id returned in a set of results.