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>'
{
  "cursor_id": "<string>",
  "prev_cursor_id": "<string>",
  "has_remaining": true,
  "remaining_count": 123,
  "total_count": 123,
  "total_size_without_cursors": "<string>",
  "results": [
    {
      "id": "<string>",
      "pk": 123,
      "filename": "<string>",
      "additional_filenames": [
        "<string>"
      ],
      "document_type": "<string>",
      "status": "<string>",
      "status_display": "<string>",
      "last_health_status": "<string>",
      "pct_complete": 123,
      "client_ref": "<string>",
      "origin": "<string>",
      "global_request_id": "<string>",
      "team__name": "<string>",
      "division__short_name": "<string>",
      "company__short_name": "<string>",
      "created_time": "2023-11-07T05:31:56Z",
      "completed_time": "2023-11-07T05:31:56Z",
      "progress_started_time": "2023-11-07T05:31:56Z",
      "parsing_completed_time": "2023-11-07T05:31:56Z",
      "subject": "<string>",
      "from_email": "<string>",
      "to_email": "<string>",
      "input_data": [
        {}
      ],
      "output_data": [
        {
          "label": "<string>",
          "output_format": "<string>",
          "scrubbed_filename": "<string>",
          "url": "<string>"
        }
      ],
      "input_file_url": "<string>",
      "extra_data": {},
      "ping_maps": {
        "status": "<string>",
        "status_display": "<string>",
        "status_pct_complete": 123,
        "status_reason": "<string>",
        "url": "<string>"
      },
      "ping_maps_url": "<string>",
      "updates": {},
      "all_updates": [
        {
          "completed_time": "2023-11-07T05:31:56Z",
          "document_type": "<string>",
          "filename": "<string>",
          "num_rows": 123,
          "original_sovid": "<string>",
          "output_formats": [
            "<string>"
          ],
          "outputs": [
            {
              "completed_time": "2023-11-07T05:31:56Z",
              "label": "<string>",
              "output_format": "<string>",
              "scrubbed_filename": "<string>",
              "url": "<string>"
            }
          ],
          "posted_time": "2023-11-07T05:31:56Z",
          "record_type": "<string>",
          "sheet_name": "<string>",
          "sov_data_last_updated_date": "2023-11-07T05:31:56Z",
          "sovid": "<string>",
          "status": "<string>",
          "sudid": "<string>"
        }
      ],
      "latest_revision": 123,
      "num_buildings": 123,
      "pingdata_stats": {},
      "data_readiness_score": 123,
      "data_readiness_notes": "<string>",
      "sov_type": "<string>",
      "sov_type_display": "<string>",
      "primary_naics_code": 123,
      "risk_summary": "<string>",
      "ping_certified_id": "<string>",
      "original_file_md5_checksum": "<string>",
      "original_sov_excel_sha256_checksum": "<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,
ping_vision_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
​
pingid
string

Optional filter for Ping ID.

Minimum string length: 1
​
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.

​
cursor_id
string
required

Cursor ID for the last result, use for pagination.

​
prev_cursor_id
string
required

Cursor ID for the previous page.

​
has_remaining
boolean
required

Whether there are more results available.

​
remaining_count
integer
required

Number of remaining results.

​
total_count
integer
required

Total number of results matching the query.

​
total_size_without_cursors
string
required

Total size without cursor filtering.

​
results
object[]
required

List of SOV activity results.