Use the Bulk Jobs List API to retrieve the past jobs associated with your API key.
Endpoint
GET https://api.insideview.com/api/v1/admin/jobs
Request
HTTP Headers
Header Name | Type | Required | Description |
accessToken | String | Yes |
Valid access token. |
Accept | String | No | Selects the response's content type. Valid values are application/json and application/xml (default). |
Query Parameters
Parameter Name | Type | Required | Description |
period | String | No | Period type Possible values: day, month or year |
start | String | No | Period start date. The expected format depends on the period parameter value:
|
end | String | No | Period end date. The expected format depends on the period parameter value:
|
jobStatuses | List | No | List of job statuses (see below) |
jobTypes | List | No | List of job types (see below) |
page | Integer | No | The page number of the result-set to return. Default: 1 |
resultsPerPage | Integer | No | The number of results in a page request. Min: 1, Max: 50, Default: 10 |
List of job statuses:
Value | Description |
-1 | Not Found |
0 | Failed |
1 | Accepted |
2 | Processing |
3 | Finished |
4 | Aborted |
List of job types:
Value | Description |
1 | Company Details |
2 | Contact Details |
3 | Enrich |
4 | Contact Lookup |
5 | New Contact Details |
Responses
HTTP 200
Returns either a JSON or XML data structure depending on the request Accept header.
Name | type | Description |
bulkJobs | Array | Array of bulk jobs |
bulkJobs > JobId | String | ID of a job |
bulkJobs > jobType | String | Job's type |
bulkJobs > jobStatus | String | Job's status |
bulkJobs > createdDate | String | Jon's creation date |
bulkJobs > creditsConsumed | Integer | Credits consumed |
application/json example
{ "bulkJobs": [ { "jobId": "8qe5luge0udlcqtrjraq", "jobType": "targetContactDetails", "jobStatus": "finished", "createdDate": "2015-09-08", "creditsConsumed": 90 }, { "jobId": "7o4bl5bnpdjdhjurrovb", "jobType": "enrich", "jobStatus": "finished", "createdDate": "2015-09-03", "creditsConsumed": 225 }, { "jobId": "ub718lfc3cmqdmaba20r", "jobType": "companies", "jobStatus": "finished", "createdDate": "2015-09-02", "creditsConsumed": 50 }, { "jobId": "r4qgke4nadr5bvdf3ohb", "jobType": "companies", "jobStatus": "finished", "createdDate": "2015-09-02", "creditsConsumed": 50 }, { "jobId": "r4jo1n16fsc6mdbio29o", "jobType": "contacts", "jobStatus": "finished", "createdDate": "2015-09-02", "creditsConsumed": 110 }, { "jobId": "uvvv2osict6oubgr24ps", "jobType": "targetContactDetails", "jobStatus": "finished", "createdDate": "2015-09-01", "creditsConsumed": 90 }, { "jobId": "ovt0nbphgvtd0u59kdj4", "jobType": "contacts", "jobStatus": "finished", "createdDate": "2015-09-01", "creditsConsumed": 110 }, { "jobId": "pd92epd3ath55pvtuv56", "jobType": "targetLookup", "jobStatus": "finished", "createdDate": "2015-08-27", "creditsConsumed": 0 }, { "jobId": "q4nukts5o8gs9gikmj5m", "jobType": "targetContactDetails", "jobStatus": "finished", "createdDate": "2015-08-27", "creditsConsumed": 60 }, { "jobId": "icg3pg7ag4gfj4sk03p1", "jobType": "enrich", "jobStatus": "finished", "createdDate": "2015-08-27" } ], "page": "1", "resultsPerPage": "10", "totalResults": "44" }
application/xml example
<?xml version="1.0" encoding="UTF-8"?> <bulkJobs> <bulkJob> <createdDate>2015-09-08</createdDate> <creditsConsumed>90</creditsConsumed> <jobId>8qe5luge0udlcqtrjraq</jobId> <jobStatus>finished</jobStatus> <jobType>targetContactDetails</jobType> </bulkJob> <bulkJob> <createdDate>2015-09-03</createdDate> <creditsConsumed>225</creditsConsumed> <jobId>7o4bl5bnpdjdhjurrovb</jobId> <jobStatus>finished</jobStatus> <jobType>enrich</jobType> </bulkJob> <bulkJob> <createdDate>2015-09-02</createdDate> <creditsConsumed>50</creditsConsumed> <jobId>ub718lfc3cmqdmaba20r</jobId> <jobStatus>finished</jobStatus> <jobType>companies</jobType> </bulkJob> <bulkJob> <createdDate>2015-09-02</createdDate> <creditsConsumed>50</creditsConsumed> <jobId>r4qgke4nadr5bvdf3ohb</jobId> <jobStatus>finished</jobStatus> <jobType>companies</jobType> </bulkJob> <bulkJob> <createdDate>2015-09-02</createdDate> <creditsConsumed>110</creditsConsumed> <jobId>r4jo1n16fsc6mdbio29o</jobId> <jobStatus>finished</jobStatus> <jobType>contacts</jobType> </bulkJob> <bulkJob> <createdDate>2015-09-01</createdDate> <creditsConsumed>90</creditsConsumed> <jobId>uvvv2osict6oubgr24ps</jobId> <jobStatus>finished</jobStatus> <jobType>targetContactDetails</jobType> </bulkJob> <bulkJob> <createdDate>2015-09-01</createdDate> <creditsConsumed>110</creditsConsumed> <jobId>ovt0nbphgvtd0u59kdj4</jobId> <jobStatus>finished</jobStatus> <jobType>contacts</jobType> </bulkJob> <bulkJob> <createdDate>2015-08-27</createdDate> <creditsConsumed>0</creditsConsumed> <jobId>pd92epd3ath55pvtuv56</jobId> <jobStatus>finished</jobStatus> <jobType>targetLookup</jobType> </bulkJob> <bulkJob> <createdDate>2015-08-27</createdDate> <creditsConsumed>60</creditsConsumed> <jobId>q4nukts5o8gs9gikmj5m</jobId> <jobStatus>finished</jobStatus> <jobType>targetContactDetails</jobType> </bulkJob> <bulkJob> <createdDate>2015-08-27</createdDate> <jobId>icg3pg7ag4gfj4sk03p1</jobId> <jobStatus>finished</jobStatus> <jobType>enrich</jobType> </bulkJob> <page>1</page> <resultsPerPage>10</resultsPerPage> <totalResults>44</totalResults> </bulkJobs>
HTTP 400
Invalid query parameter(s).
HTTP 401
Unauthorized Error - Cannot use API's without setting a valid accessToken in header.
HTTP 405
Method Not Allowed - Your are not allowed to access this API.
HTTP 429
Request is throttled.
Comments
0 comments
Please sign in to leave a comment.