The purpose of this call is to allow the user to ascertain the status of various asynchronous API calls that are available in Pinpointe's API call stack, such as:
- list-GetListSubscribersAsync
- news-GetNewsletterContactDataSummaryAsync
- seg-GetSegmentSubscribersAsync
- tag-GetTagSubscribersAsync
Asynchronous calls should be used when the user is targeting what is likely to be a large dataset. As such, and given the nature of asynchronous processing, the processing time for these calls can be relatively long. The api-asyncjobstatus call will return the status of a given call based on a job ID.
JSON Request Example
{
"username": "[email protected]",
"usertoken": "abc123abc123abc123abc123abc123",
"requesttype": "API",
"requestmethod": "AsyncJobStatus",
"details": {
"jobids": ["{*job_id*}", ...], /* optional, multi, none returns all */
"pagination": { /* optional */
"limit": "{*max_records*}", /* required */
"next": "{*start_at_record_number*}" /* optional: default 0 */
}
}
}"json_request" element
| Field Name | Description |
| username | Username used to login to Pinpointe |
| usertoken | Unique token assigned to Pinpointe account |
| requesttype | API |
| requestmethod | AsyncJobStatus |
Please note: ALL OPTIONAL elements that are not used should be deleted from submitted call. For example, if no pagination is to be part of the call, "pagination" and its child parameters should be deleted.
"details" element
| Field Name | Description |
| jobids (optional) | The job ID that is supplied when you run an asynchronous call. If omitted, call will return status on all asynchronous calls currently running or completed. If no jobs found, system will return an error message stating "Jobs not found". |
"pagination" element
Please note: If "pagination" parameters omitted, call will return as many records as allowable based on current application memory constraints.
| Field Name | Description |
| limit (optional but required if "next" parameter used) | max_records: Integer indicating maximum number of datasets (records) to be returned for the respective call. |
| next (optional) | start_at_record_number: If parameter used, the call response will be limited to the “limit” value and the response will include a pagination section with the appropriate “next” value to return the next sequential chunk of records, or “0” if all records have been returned. |
Successful Response:
"response" element
| Field Name | Description |
| status | Will return SUCCESS if job Id successfully retrieved |
| data | See example below |
Sample Response:
