_links |
Object |
Links to the related REST APIs |
_embedded |
Object |
Contains the results and additional data |
_embedded[jobs] |
Object[] |
Array containing the campaigns. |
_embedded[jobs][x] |
Object[] |
Object containing data of a campaign. |
_embedded[jobs][x][id] |
Number |
The id of the job. |
_embedded[jobs][x][name] |
String |
The name of the job. |
_embedded[jobs][x][progressCurrent] |
Number |
The current progress of the job, for example number of already imported rows when importing. |
_embedded[jobs][x][progressMax] |
Number |
The maximum progress of the job, for example the total number of rows when importing. |
_embedded[jobs][x][started] |
Object |
Date object containing data about when the job started. |
_embedded[jobs][x][started][date] |
String |
The exact time when the job started. |
_embedded[jobs][x][started][timezone] |
String |
The timezone of the user. |
_embedded[jobs][x][started][timezone_type] |
Number |
|
_embedded[jobs][x][finished] |
Object |
Date object containing data about when the job finished.
Only campaign send jobs get this value.
|
_embedded[jobs][x][finished][date] |
String |
The exact time when the job started. |
_embedded[jobs][x][finished][timezone] |
String |
The timezone of the user. |
_embedded[jobs][x][finished][timezone_type] |
Number |
|
_embedded[jobs][x][status] |
String |
The status of the job.
Values: SCHEDULED , RUNNING , PAUSED , FINISHED , CANCELED , ERROR , SCHEDULED_PAUSED , CONTACT_LIMIT_REACHED , EMAIL_LIMIT_REACHED |
_embedded[jobs][x][visibleUntil] |
Object |
The time object indicating when the job will disappear. |
_embedded[jobs][x][visibleUntil][date] |
String |
The exact time when the job disappears. |
_embedded[jobs][x][visibleUntil][timezone] |
String |
The timezone of the user. |
_embedded[jobs][x][visibleUntil][timezone_type] |
Number |
|
_embedded[jobs][x][type] |
String |
The type of the job.
Values: EMAIL_SEND , SEGMENT_CALCULATE , SEGMENT_SAVE , IMPORT_CONTACTS , EXPORT_TABLE , CAMPAIGN_SEND , LEAD_SCORE_GENERATE , SPLIT_TEST , SPLIT_TEST_CAMPAIGN , IMPORT_CONTACTS_FROM_ARRAY , BULK_CHANGE |
_embedded[jobs][x][referenceId] |
Number |
The campaign, segment, import, etc. id the job refers to. |
_embedded[jobs][x][parent] |
Number. |
The id of the parent job if there is one. |
_embedded[jobs][x][isStoppable] |
Boolean |
Shows if the job is stoppable. |
_embedded[jobs][x][isPausable] |
Boolean |
Shows if the job is pauseable. |
_embedded[jobs][x][children] |
Array |
Array containing the id of children jobs. |
_embedded[jobs][x][_links] |
Object |
Links to the related REST APIs |
page_count |
Integer |
The number of pages needed to show the results. |
page_size |
Integer |
The number of items shown on one page. |
total_items |
Integer |
The number of results. |
page |
Integer |
The actual page. |