Job Status and Download API

The Job Status API will provide a JSON response containing status of the processing list.

Format

API End point: https://api.versium.com/v2/jobs/<job-id>

Http method: GET

Response Structure
Content-type: application/json

Processing response:

{ "versium": { "version": "2.0", "query_id": "5469d7473619e8cba393626392b1e9dc", "query_time": 0.0992732048034668, "results": { "id": 622002, "guid": "d4c0fb1c-7f9b-4255-8bf4-8b03806a40f7", "state": "processing", "operation": "b2cPeopleListGen", "created_at": "2023-10-02 21:29:08", "finished_at": "2023-10-02 21:29:15", "output_list": { "id": 486966, "download_url": "https://api.versium.com/v2/lists/486966/download", "num_matches": 588, "num_records": 294, "project_id": 76416 }, "state_url": "https://api.versium.com/v2/jobs/622002", "callback_url": null, "suppression_input_list_ids": null "est_sec_remaining": 30, "progress_percentage": 73 } } }

Completed job:

Once the job is completed, the response will contain the "state":"Done" string. The response will also contain the following:

  • download URL - the url that can be used to download the generated list in CSV format.
  • number of matches in the list
  • number of records in the list
  • insights - a set of data containing the insights of the generated list
{ "versium": { "version": "2.0", "query_id": "5469d7473619e8cba393626392b1e9dc", "query_time": 0.0992732048034668, "results": { "id": 622002, "guid": "d4c0fb1c-7f9b-4255-8bf4-8b03806a40f7", "state": "done", "operation": "b2cPeopleListGen", "created_at": "2023-10-02 21:29:08", "finished_at": "2023-10-02 21:29:15", "output_list": { "id": 486966, "download_url": "https://api.versium.com/v2/lists/486966/download", "num_matches": 588, "num_records": 294, "project_id": 76416 }, "state_url": "https://api.versium.com/v2/jobs/622002", "callback_url": null, "suppression_input_list_ids": null } } }

When the job has completed, a “download_url” will be provided, and the “state” will be “done”.

Download List

API End point: https://api.versium.com/v2/lists/<list-id>/download

Note: the API End point is fully provided in the download_url - Example from above "download_url": "<https://api.versium.com/v2/lists/486966/download>"

Method: GET

Response Structure
If successful, this URL will stream back a comma-separated list of data records. The first line will be the header.

Content-type: application/csv

Timestamp,"First Name","Last Name","Postal Address",City,State,Zip,County,Phone 20230828,John,Smith,"122 15th St SW",Lynnwood,WA,98036,Snohomish,5554502846 20230828,Jane,Kirk,"18232 4th Ave W",Lynnwood,WA,98036,Snohomish,5551762254 20230828,Derrick,Rogers,"1731 Damson Rd Unit H1",Lynnwood,WA,98036,Snohomish,5553400639