Follow

Job Status API

Job Status API

This REST API retrieves the status of the background job that adds users specified in an Adaptive Campaign API request. The request is asynchronous so it returns results immediately while the background job is still running. You can check on the job status until you confirm that it is complete.

To use this API, you need the job identifier of the background job, which is provided in the response body of a successful Adaptive Campaign API request. Limit your calls to the Job Status API to no more than once every 30 seconds.

API Request

Request URI and Header

Request URI - HTTP GET

To target the production environment: https://tap-nexus.appspot.com/api/campaign/populate/job_id?env=p

To target the sandbox environment: https://tap-nexus.appspot.com/api/campaign/populate/job_id?env=s

Note: You must specify the same environment you used in your Adaptive Campaign API request status.

Request Header

The Job Status API uses a single HTTP request header, which specifies authentication credentials. To use the Job Status API, you need authorization to use the Adaptive Campaign API.

The authentication request header for the Job Status API is the same as the header for the Adaptive Campaign API. See Adaptive Campaign API.

Request Body

The Job Status API uses the HTTP GET verb so it does not use a request body. All of the information for the request is encoded on the URI.

API Response

The response to a Job Status API request is an HTTP response code and a response body.

HTTP Response Codes
Codes
200 The server authenticated and authorized the request based on the supplied HTTP request header and found the specified job_id. This response code is accompanied by a success response body.
400 Syntax error. The request does not use the HTTP GET verb or the specified value of job_id does not exist.
401 Authentication error. The Secret Key supplied in the HTTP header is not found or the API Key supplied with the Secret Key is incorrect.
409 Authorization error. The specified Secret Key does not have permission to use the Adaptive Campaign API. Permission to use the Campaign API is required if you want to use the Job Status API.
Response Body
Fields
job_id

The Kahuna-assigned job identifier. Repeats the job identifier you added to the URI when you sent the request.

created

The date and time at which the server started the background job to add users to the campaign. The timestamp is in ISO 8601 format YYYY-MM-DDThh:mm:ss.ssssss. The timezone is UTC.

status

The status of the background job. One of three possible values:

  • RUNNING—the job is running.
  • PENDING—the job is waiting to start.
  • DONE—the job is complete.
  • FAILED—some part of the job failed.
campaign_id The Kahuna campaign identifier. Repeats the campaign identifier you supplied in your Adaptive Campaign API request.
cred_type Repeats the user credential type you supplied for the Adaptive Campaign API request.
observe_rate_limiting Indicates if rate limiting should be applied to the added users. Repeats the observe_rate_limiting setting for your Adaptive Campaign API request.
target_global_control

Indicates if control users should be added to the campaign. Repeats the target_global_control setting you set in campaign_config for the Adaptive Campaign API request associated with job_id.

total_users_requested The number of users you specified in the Adaptive Campaign API request associated with job_id.
total_users_scheduled The total number of users that the background job scheduled for the push campaign.
total_users_not_found The total number of users that the background job was unable to find.
errors Error information. The fields that list errors in the Adaptive Campaign API request represented by the job identifier. The users_not_found field contains an array of user credentials that cannot be found in the database. The type of each element of the array depends on the type of the user credential. Because of the error reporting limit for the Adaptive Campaign API, the users_not_found array is limited to 1000 user credentials.
track_only For internal use.
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments