> ## Documentation Index > Fetch the complete documentation index at: https://docs.pingintel.com/llms.txt > Use this file to discover all available pages before exploring further. # List SOV Activity > Fetch a list of the most recent SOV Fixer activity. If desired, the returned `fields` can be configured and the responses can be filtered by `status`, `origin`, etc. ## OpenAPI ````yaml https://api-staging.sovfixer.com/api/schema/?format=json get /api/v1/sov/activity openapi: 3.0.3 info: title: Ping.Extraction API version: v1.0 description: >- ### Ping.Extraction API This API provides an asynchronous method for parsing Excel SOV documents using the Ping Intel SOV Fixer platform. The typical SOV Fixer usage flow is: * POST to `/api/v1/sov` * Poll GET `/api/v1/sov/{id}`, passing the `id` given by the previous response until `response.request.status` is `COMPLETE` or `FAILED`. Depending on load, number of buildings in the SOV, and 3rd party integrations, it may take anywhere from a few seconds to many minutes. * Download the parsed SOV data as JSON from `/api/v1/sov/{id}/output/{filename}`. The exact url comes from the response to the above query, in `response.result.outputs[].url`. API Usage Examples: [Python](/api/v1/sov-api-usage-example.py) | [.NET](/api/v1/sov-api-usage-example.cs) Client Libraries: [Python](https://pypi.org/project/pingintel-api/) #### Authorization Most endpoints are protected by Bearer authentication. Under each endpoint listed below, click into the `authorizations` section to see what is required for that endpoint. #### Output JSON Example: ```json { "id": "s-e-xxxxxxx", "source_filename": "My Example SOV.xls", "num_buildings": 26, "extra_data": { "insured_name": "Joe Insured", "... custom document-level data fields ...": "" }, "buildings": [ { "item_key": "i-s-e-xxxxxxx!Original SOV Sheet!7", "building_counter": 1, "sheet_name": "Original SOV Sheet", "sheet_row_number": 7, "parsing_sheet_name": "Original SOV Sheet", "location_code": { "value": "A-1", "confidence": 0.5, "comment": "Adjusted." }, "bldg_name": { "value": "Elementary School", "confidence": 0.7 }, "street": { "value": "1212 Mockingbird Lane", "confidence": 0.7 }, "city": { "value": "Tewksbury", "confidence": 0.5 }, "state": { "original": "Mass", "value": "MA", "confidence": 0.9 }, "zip": { "value": "01876", "original": 1876, "confidence": 0, "comment": "Please check." }, "... more building attributes ...": "", "external_data": { "PG": { "latitude": 42.6109, "longitude": -71.2342, "confidence": 0.9, "street": "1212 Mockingbird Ln", "city": "Tewksbury", "... rest of the data from the Ping Geocoding (PG) external data source ...": "" }, "... any other requested third party data sources ...": "" }, "extra": { "... columns that were not identified as a standard SOV field ...": "", "Unidentified Column": "123213", "Another Unidentified Column": "abc" } }, "... additional buildings ...": "" ] } ``` Complete JSON reference documentation can be found for each output type: [SOV](/docs/data/SOV/) | [Premium BDX](/docs/data/PREM_BDX/) | [Claim BDX](/docs/data/CLAIM_BDX/). Some notes about specific JSON output fields: * `limits__total_limit`: Contains the TIV if explicitly specified in the SOV. If not, it is summed from the fields `limits__building_limit` + `limits__bpp_limit` + `limits__bi_limit` + `limits__signs_and_other_limit`. * `limits__building_limit`: Building Limit is an aggregate of: * `limits__building_value` * `limits__location_limit` * `limits__blanket_limit` * `limits__building_only_limit` * `limits__real_property_limit` * `limits__structure_limit` * `limits__bpp_limit`: Business Personal Property (Contents) Limit is an aggregate of: * `limits__contents_value` * `limits__contents_limit` * `limits__bpp_value` * `limits__equip_limit` * `limits__personal_property_limit` * Any field identified as a limit field but not otherwise categorized. * `limits__bi_limit`: Business Interruption Limit is an aggregate of: * `limits__bi_value` * `limits__bi_income_limit` * `limits__business_interruption_limit` * `limits__time_element_limit` * `limits__signs_and_other_limit`: Signs and Other Structures Limit is an aggregate of: * `limits__signs_limit` * `limits__other_structures_limit` ### Ping Intel SOV History API This API provides a method for accessing historical SOV submissions including their revisions (SOV Updates) and the raw parsed output. The typical usage workflow is: * GET to `api/v1/sov/history?start={start_timestamp}` for a list of SOVIDs submitted between `start_timestamp` and now. * For each sovid: * GET to `api/v1/sov/history/{id}` to get information about the SOV or SOV Update. This includes any output we produced in servicing the request * GET to the the URL in the outputs dict to download the resource you need. contact: email: support@pingintel.com name: Ping Intel url: https://www.pingintel.com servers: - url: https://api.sovfixer.com description: Ping.Extraction API - url: https://api-staging.sovfixer.com description: Ping.Extraction API (staging) security: [] paths: /api/v1/sov/activity: get: tags: - Get SOV Data summary: List SOV Activity description: >- Fetch a list of the most recent SOV Fixer activity. If desired, the returned `fields` can be configured and the responses can be filtered by `status`, `origin`, etc. operationId: sov_activity_retrieve parameters: - in: query name: company__short_name schema: type: array items: type: string minLength: 1 description: Optional filter for companies. - in: query name: completed_time__gt schema: type: string format: date-time description: >- 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`. - in: query name: completed_time__gte schema: type: string format: date-time description: >- 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`. - in: query name: completed_time__lt schema: type: string format: date-time description: >- 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`. - in: query name: completed_time__lte schema: type: string format: date-time description: >- 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`. - in: query name: cursor_id schema: type: string minLength: 1 description: >- 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. - in: query name: division__short_name schema: type: array items: type: string minLength: 1 description: Optional filter for divisions. - in: query name: fields schema: type: array items: type: string enum: - 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 - pingid - primary_naics_code - progress_started_time - risk_summary - sov_type - sov_type_display - status - status_display - subject - team__name - to_email - updates description: Optional. List of field names to include on each result. explode: false style: form - in: query name: id schema: type: string minLength: 1 description: Optional filter for sovid. - in: query name: origin schema: type: array items: enum: - api - email type: string description: |- * `api` - api * `email` - email x-spec-enum-id: ca93a50f219e38ba description: Optional filter for origins. - in: query name: page_size schema: type: integer maximum: 250 minimum: 1 default: 50 description: Optional. The maximum number of results returned in a page. - in: query name: pingid schema: type: string minLength: 1 description: Optional filter for Ping ID. - in: query name: prev_cursor_id schema: type: string minLength: 1 description: >- Optional. When this parameter is set from the prev_cursor_id provided in a previous response, it will provide the previous page of results. - in: query name: readiness schema: type: number format: double description: Optional filter for data readiness equal to than. - in: query name: readiness__gt schema: type: number format: double description: Optional filter for data readiness greater than. - in: query name: readiness__lt schema: type: number format: double description: Optional filter for data readiness less than. - in: query name: search schema: type: string minLength: 1 description: Optional. Global search substring. Case insensitive. - in: query name: status schema: type: string minLength: 1 description: Optional filter for status. responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListActivityResponse' description: Successful response with a list of SOV activities. '400': content: application/json: schema: $ref: '#/components/schemas/SOVActivityError400' description: '' '401': content: application/json: schema: $ref: '#/components/schemas/SOVActivityError401' description: '' security: - tokenAuth: [] - cookieAuth: [] components: schemas: ListActivityResponse: type: object properties: cursor_id: type: string description: Cursor ID for the last result, use for pagination. has_remaining: type: boolean description: Whether there are more results available. prev_cursor_id: type: string description: Cursor ID for the previous page. remaining_count: type: integer description: Number of remaining results. results: type: array items: $ref: '#/components/schemas/ListActivityResult' description: List of SOV activity results. total_count: type: integer description: Total number of results matching the query. total_size_without_cursors: type: string description: Total size without cursor filtering. required: - cursor_id - has_remaining - prev_cursor_id - remaining_count - results - total_count - total_size_without_cursors SOVActivityError400: type: object properties: error: type: string description: Server error message detail. required: - error SOVActivityError401: type: object properties: detail: type: string description: Authorization error message. required: - detail ListActivityResult: type: object properties: additional_filenames: type: array items: type: string description: Additional filenames associated with the SOV. all_updates: type: array items: $ref: '#/components/schemas/SOVUpdates' description: List of all updates/revisions. client_ref: type: string description: Client reference identifier. company__short_name: type: string description: Company short name. completed_time: type: string format: date-time description: Time the SOV was completed. created_time: type: string format: date-time description: Time the SOV was created. data_readiness_notes: type: string description: Notes about data readiness. data_readiness_score: type: number format: double description: Data readiness score (0-100). division__short_name: type: string description: Division short name. document_type: type: string description: Type of document. extra_data: type: object additionalProperties: {} description: Additional data. filename: type: string description: Original filename. from_email: type: string description: Sender email address. global_request_id: type: string description: Global request identifier. id: type: string description: SOV identifier. input_data: type: array items: type: object additionalProperties: {} description: Input data provided. input_file_url: type: string description: URL to download the original input file. last_health_status: type: string description: Last health status message. latest_revision: type: integer description: Latest revision number. num_buildings: type: integer description: Number of buildings in the SOV. origin: type: string description: Origin of the SOV. original_file_md5_checksum: type: string description: MD5 checksum of the original file. original_sov_excel_sha256_checksum: type: string description: SHA256 checksum of the original SOV Excel. output_data: type: array items: $ref: '#/components/schemas/OutputData' description: Output files generated. parsing_completed_time: type: string format: date-time description: Time parsing was completed. pct_complete: type: integer description: Percentage complete. ping_certified_id: type: string description: Ping Certified identifier. ping_maps: allOf: - $ref: '#/components/schemas/PingMaps' description: Ping Maps status and URL. ping_maps_url: type: string description: URL to the Ping Maps view. pingdata_stats: type: object additionalProperties: {} description: Ping Data enrichment statistics. pk: type: integer description: Primary key. primary_naics_code: type: integer description: Primary NAICS code. progress_started_time: type: string format: date-time description: Time processing started. risk_summary: type: string description: Summary of the risk. sov_type: type: string description: SOV type code. sov_type_display: type: string description: Human-readable SOV type. status: type: string description: Status code. status_display: type: string description: Human-readable status. subject: type: string description: Email subject if submitted via email. team__name: type: string description: Team name. to_email: type: string description: Recipient email address. updates: type: object additionalProperties: {} description: Dictionary of updates keyed by revision number. required: - 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 - pk - primary_naics_code - progress_started_time - risk_summary - sov_type - sov_type_display - status - status_display - subject - team__name - to_email - updates SOVUpdates: type: object properties: completed_time: type: string format: date-time description: Time the update was completed. document_type: type: string description: Type of document (e.g., 'SOV'). filename: type: string description: Original filename. num_rows: type: integer description: Number of rows in the SOV. original_sovid: type: string description: Original SOV ID if this is a revision. output_formats: type: array items: type: string description: List of output formats generated. outputs: type: array items: $ref: '#/components/schemas/UpdateOutput' description: List of output files for this update. posted_time: type: string format: date-time description: Time the update was posted. record_type: type: string description: Type of record (e.g., 'SCRUB'). sheet_name: type: string description: Name of the sheet in the SOV. sov_data_last_updated_date: type: string format: date-time description: Last updated date for SOV data. sovid: type: string description: SOV identifier. status: type: string description: Status of the update. sudid: type: string description: SOV Update identifier. required: - completed_time - document_type - filename - num_rows - original_sovid - output_formats - outputs - posted_time - record_type - sheet_name - sov_data_last_updated_date - sovid - status - sudid OutputData: type: object properties: label: type: string description: Label for the output. output_format: type: string description: Format of the output file. scrubbed_filename: type: string description: Filename of the scrubbed output. url: type: string description: URL to download the output file. required: - label - output_format - scrubbed_filename - url PingMaps: type: object properties: status: type: string description: Map status code. status_display: type: string description: Human-readable map status. status_pct_complete: type: integer description: Percentage complete for map generation. status_reason: type: string description: Reason for the current status. url: type: string description: URL to view the map, if available. required: - status - status_display - status_pct_complete - status_reason - url UpdateOutput: type: object properties: completed_time: type: string format: date-time description: Time the output was completed. label: type: string description: Label for the output. output_format: type: string description: Format of the output file. scrubbed_filename: type: string description: Filename of the scrubbed output. url: type: string description: URL to download the output file. required: - completed_time - label - output_format - scrubbed_filename - url securitySchemes: tokenAuth: type: apiKey in: header name: Authorization description: Token-based authentication with required prefix "Token" cookieAuth: type: apiKey in: cookie name: sessionid ````