Statuses

Below are the various status codes that may populate the status property.

Status IntegerDescription
-1Job uploading, or transmission in progress.
0Job has been received successfully and has entered the system queue.
1Parsing your file to determine totals, detect bad data, and duplicate entries.
2Job parsing has completed, this job is ready to run.
3Job is currently in progress.
4Job has successfully completed, results are available.
5An unexpected failure has occurred, this job could not run (typically due to bad CSV data).

File Details

Contains information we've gathered from the file. It may be useful when trying to debug a job that failed.

🚧

This property is returned as a JSON string and will need to be inflated before accessing the properties.

PropertyDescription
email_col_iZero-based index of the column the emails are contained
tot_colsNumber of columns we found in the CSV
delimiterThe delimiter we detected from the CSV
has_headerWhether or not we detected a header
sizeThe size of the file or data supplied in bytes
tot_recordsTotal number of records detected in CSV
tot_emailsTotal number fo emails found in the CSV

Job Details

📘

Returned with version 3.1 or later

PropertyDescription
sample_statusOnly available after free analysis
Contains integer describing the sample status. See Sample Statuses for additional details.
sample_detailsOnly available after free analysis
Contains details about the free sample after completion. See Sample Details for additional details.

Sample Status

Status IntegerDescription
1Indicates we have received the request to run the job as a sample.
2We are currently processing your free sample job.
3We have finished processing your sample job.
4We have finished processing your sample job.

Sample Details

PropertyDescription
sample_sizeThe number of records chosen to test for a free sample (typically 10% of the total)
sample_statsContains the job's analysis results
bounce_estimateThe estimated bounce rate for this list (0.0 is 0% and 1.0 is 100%)
Language
Click Try It! to start a request and see the response here!