[GET] - Bulk Jobs List

  • Updated

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.
See Authentication and Authorization Overview for more details.
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:
  • day: YYYY-MM-DD
  • Month: YYYY-MM
  • Year: YYYY
Ex: 20014-09-01, 2014-09, 2014
 end  String No  Period end date. The expected format depends on the period parameter value:
  • day: YYYY-MM-DD
  • Month: YYYY-MM
  • Year: YYYY
Ex: 20014-09-30, 2014-10, 2015
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

 

Type: application/json

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "/",
  "type": "object",
  "properties": {
    "bulkJobs": {
      "id": "bulkJobs",
      "type": "array",
      "items": [
        {
          "id": "0",
          "type": "object",
          "properties": {
            "jobId": {
              "id": "jobId",
              "type": "string"
            },
            "jobType": {
              "id": "jobType",
              "type": "string"
            },
            "jobStatus": {
              "id": "jobStatus",
              "type": "string"
            },
            "createdDate": {
              "id": "createdDate",
              "type": "string"
            },
            "creditsConsumed": {
              "id": "creditsConsumed",
              "type": "integer"
            }
          }
        }
      ]
    },
    "page": {
      "id": "page",
      "type": "integer"
    },
    "resultsPerPage": {
      "id": "resultsPerPage",
      "type": "integer"
    },
    "totalResults": {
      "id": "totalResults",
      "type": "integer"
    }
  }
}

Example

{
  "bulkJobs": [
    {
      "jobId": "gqack4st85ffclb2qig1",
      "jobType": "targetCompanyDetails",
      "jobStatus": "finished",
      "createdDate": "2015-08-17"
    },
    {
      "jobId": "a64r4kta2vqrf477fhpb",
      "jobType": "targetLookup",
      "jobStatus": "finished",
      "createdDate": "2015-08-17"
    },
    {
      "jobId": "2jobbjdic993qoqutc9g",
      "jobType": "targetContactDetails",
      "jobStatus": "finished",
      "createdDate": "2015-08-17"
    },
    {
      "jobId": "s1hkd323hh9riarqjmio",
      "jobType": "targetContactDetails",
      "jobStatus": "finished",
      "createdDate": "2015-08-17"
    },
    {
      "jobId": "ebnn3ldr07e2qkarfsh7",
      "jobType": "contacts",
      "jobStatus": "finished",
      "createdDate": "2015-08-17"
    },
    {
      "jobId": "8guhshefq6vd9g8o9890",
      "jobType": "companies",
      "jobStatus": "finished",
      "createdDate": "2015-08-17"
    },
    {
      "jobId": "63n4g7n9vndhihl0du11",
      "jobType": "enrich",
      "jobStatus": "finished",
      "createdDate": "2015-08-17"
    },
    {
      "jobId": "t4det4adpqejbo9bnr7i",
      "jobType": "targetCompanyDetails",
      "jobStatus": "finished",
      "createdDate": "2015-08-17"
    },
    {
      "jobId": "ibtblodsedrhudgurttc",
      "jobType": "targetLookup",
      "jobStatus": "finished",
      "createdDate": "2015-08-17"
    },
    {
      "jobId": "kgchahq0g1dt9foneoko",
      "jobType": "targetContactDetails",
      "jobStatus": "finished",
      "createdDate": "2015-08-17"
    }
  ],
  "page": "1",
  "resultsPerPage": "10",
  "totalResults": "16788"
}

Type: application/xml

Schema

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="bulkJobs">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="bulkJob" minOccurs="0" maxOccurs="unbounded">
                    <xs:complexType>
                        <xs:sequence>
                        	<xs:element name="createdDate" type="xs:string" minOccurs="0"/>
                            <xs:element name="jobId" type="xs:string" minOccurs="0"/>
                             <xs:element name="jobStatus" type="xs:string" minOccurs="0"/>
                            <xs:element name="jobType" type="xs:string" minOccurs="0"/> 
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
                <xs:element name="page" type="xs:int" minOccurs="0"/>
                <xs:element name="resultsPerPage" type="xs:int" minOccurs="0"/>
                <xs:element name="totalResults" type="xs:int" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
</xs:schema>

Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bulkJobs>
    <bulkJob>
        <createdDate>2015-08-17</createdDate>
        <jobId>gqack4st85ffclb2qig1</jobId>
        <jobStatus>finished</jobStatus>
        <jobType>targetCompanyDetails</jobType>
    </bulkJob>
    <bulkJob>
        <createdDate>2015-08-17</createdDate>
        <jobId>a64r4kta2vqrf477fhpb</jobId>
        <jobStatus>finished</jobStatus>
        <jobType>targetLookup</jobType>
    </bulkJob>
    <bulkJob>
        <createdDate>2015-08-17</createdDate>
        <jobId>2jobbjdic993qoqutc9g</jobId>
        <jobStatus>finished</jobStatus>
        <jobType>targetContactDetails</jobType>
    </bulkJob>
    <bulkJob>
        <createdDate>2015-08-17</createdDate>
        <jobId>s1hkd323hh9riarqjmio</jobId>
        <jobStatus>finished</jobStatus>
        <jobType>targetContactDetails</jobType>
    </bulkJob>
    <bulkJob>
        <createdDate>2015-08-17</createdDate>
        <jobId>ebnn3ldr07e2qkarfsh7</jobId>
        <jobStatus>finished</jobStatus>
        <jobType>contacts</jobType>
    </bulkJob>
    <bulkJob>
        <createdDate>2015-08-17</createdDate>
        <jobId>8guhshefq6vd9g8o9890</jobId>
        <jobStatus>finished</jobStatus>
        <jobType>companies</jobType>
    </bulkJob>
    <bulkJob>
        <createdDate>2015-08-17</createdDate>
        <jobId>63n4g7n9vndhihl0du11</jobId>
        <jobStatus>finished</jobStatus>
        <jobType>enrich</jobType>
    </bulkJob>
    <bulkJob>
        <createdDate>2015-08-17</createdDate>
        <jobId>t4det4adpqejbo9bnr7i</jobId>
        <jobStatus>finished</jobStatus>
        <jobType>targetCompanyDetails</jobType>
    </bulkJob>
    <bulkJob>
        <createdDate>2015-08-17</createdDate>
        <jobId>ibtblodsedrhudgurttc</jobId>
        <jobStatus>finished</jobStatus>
        <jobType>targetLookup</jobType>
    </bulkJob>
    <bulkJob>
        <createdDate>2015-08-17</createdDate>
        <jobId>kgchahq0g1dt9foneoko</jobId>
        <jobStatus>finished</jobStatus>
        <jobType>targetContactDetails</jobType>
    </bulkJob>
    <page>1</page>
    <resultsPerPage>10</resultsPerPage>
    <totalResults>16788</totalResults>
</bulkJobs>

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.

 

Was this article helpful?

0 out of 0 found this helpful