[GET] - Subscription Jobs List

Follow

Use this Subscription Jobs List API to retrieve the past Notification Subscription jobs associated with your API key.

Endpoint

GET https://api.insideview.com/api/v1/subscription/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 Ex: "failed", "accepted", "processing", "finished", "aborted", "ready"
jobTypes List No Ex: "notificationSubscriptionUpdate"
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

Responses

HTTP 200

Returns either a JSON or XML data structure depending on the request Accept header. 

Name type Description
subscriptionJobs Array  Array of jobs
subscriptionJobs> JobId  String ID of a job
subscriptionJobs> jobType String Job's type
subscriptionJobs > jobStatus String Job's status
subscriptionJobs> subscriptionId String Subscription ID 
subscriptionJobs>createdDate String Job Creation date for Subscription
subscriptionJobs>creditsConsumed Integer Credits consumed 

application/json example

{
  "subscriptionJobs": [
    {
      "jobId": "6gf220p5pat3e1juh8us",
      "subscriptionId": "631gp2hs8h0o4jhrrso5",
      "jobType": "notificationSubscriptionUpdate",
      "jobStatus": "finished",
      "createdDate": "2015-09-16",
      "creditsConsumed": 0
    },
    {
      "jobId": "7lb3fmvr88l5l5ap9i16",
      "subscriptionId": "43e5cf59b4mta2h6ccoo",
      "jobType": "notificationSubscriptionUpdate",
      "jobStatus": "finished",
      "createdDate": "2015-09-11",
      "creditsConsumed": 0
    },
    {
      "jobId": "ecgsd2u5ahl1lhbfcv3c",
      "subscriptionId": "f0ua3h9m28p7hr120ffg",
      "jobType": "notificationSubscriptionUpdate",
      "jobStatus": "finished",
      "createdDate": "2015-09-11",
      "creditsConsumed": 0
    }
  ],
  "page": "1",
  "resultsPerPage": "10",
  "totalResults": "3"
}

application/xml example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<subscriptionJobs>
    <page>1</page>
    <resultsPerPage>10</resultsPerPage>
    <subscriptionJob>
        <createdDate>2015-09-16</createdDate>
        <creditsConsumed>0</creditsConsumed>
        <jobId>6gf220p5pat3e1juh8us</jobId>
        <jobStatus>finished</jobStatus>
        <jobType>notificationSubscriptionUpdate</jobType>
        <subscriptionId>631gp2hs8h0o4jhrrso5</subscriptionId>
    </subscriptionJob>
    <subscriptionJob>
        <createdDate>2015-09-11</createdDate>
        <creditsConsumed>0</creditsConsumed>
        <jobId>7lb3fmvr88l5l5ap9i16</jobId>
        <jobStatus>finished</jobStatus>
        <jobType>notificationSubscriptionUpdate</jobType>
        <subscriptionId>43e5cf59b4mta2h6ccoo</subscriptionId>
    </subscriptionJob>
    <subscriptionJob>
        <createdDate>2015-09-11</createdDate>
        <creditsConsumed>0</creditsConsumed>
        <jobId>ecgsd2u5ahl1lhbfcv3c</jobId>
        <jobStatus>finished</jobStatus>
        <jobType>notificationSubscriptionUpdate</jobType>
        <subscriptionId>f0ua3h9m28p7hr120ffg</subscriptionId>
    </subscriptionJob>
    <totalResults>3</totalResults>
</subscriptionJobs>

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.

 

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk