iQ Revisions API endpoints
The GET iQ Revisions API uses JSON objects to retrieve revisions data.
GET revisions
GET Revisions returns an array of revision IDs. The revision ID is the timestamp of the revision in the form of YYYYMMDDHHMM
. This ID is used to fetch the revision details.
Use the following GET command to list revisions:
GET /v2/manifest/accounts/{account}/profiles/{profile}/revisions
Example cURL request
curl -H 'Authorization: Bearer {token}' \
https://api.tealiumiq.com/v2/manifest/accounts/{account}/profiles/{profile}/revisions
Example response
["201508181719",
"201508181718",
"201508181717"]
Revision IDs are listed in reverse chronological order with the newest revision listed first.
Error messages
Potential error messages for this task are:
Error Message | Description |
---|---|
404 Not Found | { "returnCode" : 1240, "message" : "Account was not found" } |
404 Not Found | { "returnCode" : 1250, "message" : "Profile was not found" } |
Get revision details
GET Revision Details returns the details for the revision specified.
Use the following GET command to return details about a revision:
GET /v2/manifest/accounts/{account}/profiles/{profile}/revisions/{revision_id}/details
Example cURL request
curl -H 'Authorization: Bearer {token}' \
https://api.tealiumiq.com/v2/manifest/accounts/{account}/profiles/{profile}/revisions/{revision_id}/details
Example Response
{
"account": "tealium",
"profile": "profile",
"name": "Full Release - 2016/12/13 19:53",
"time_created": "Tue 2016.12.13 19:54 GMT",
"checksums": {
"prod": {
"manifest.json": "df8bb8bdb8bc34f9d70d98ff49fdcf53e7f286520747001538b74357418178a2",
"bundle.zip": "9309364527db38cd33538ca239929c3ed89b7b6990e99b4a41d16b50dd519e35",
"utag.js": "3c34236708b14e8fd8a82e5c363d006793fd59fc6f6a6f0367634cf245d16861",
"utag.1.js": "9b911570ac0685a50a3a32ef780a2570b16725779b7336bdbfca2838eea6d216",
"utag.2.js": "0d3cbf8b3d275d181c2140c2eab88ead3c9f2002b5260d9ebd9f23cb7b60de9a"
}
},
"revision_id": "201612131954",
"comment": "up to date publish",
"created_by": "user@example.com",
"targets_published": ["prod"]
}
Error messages
Potential error messages for this task are:
Error Message | Description |
---|---|
404 Not Found | {"returnCode" : 1240, "message" : "Account was not found" } |
404 Not Found | {"returnCode" : 1250, "message" : "Profile was not found" } |
404 Not Found | {"returnCode" : 1260, "message" : "Revision details do not exist"} |
GET revision bundle
A revision bundle is the deployable combination of published JavaScript files for the target environment in the form of a .zip
file. If a revision was published, the value from targets_published
is used in this endpoint to retrieve the desired files, such as prod
.
GET /v2/manifest/accounts/{account}/profiles/{profile}/revisions/{revision_id}/environments/{environment}
Example cURL request
curl -H 'Authorization: Bearer {token}' \
http://api.tealiumiq.com/v2/manifest/accounts/{account}/profiles/{profile}/revisions/{revision_id}/environments/{environment}
Example response
The response for the cURL command is the return of a .zip
file containing the following individual files:
File Name | Contents |
---|---|
utag.js |
The main loader file |
utag.*.js |
The vendor tag files, such as utag.13.js |
utag.sync.js |
(Optional) Contains the synchronous loader file |
mobile.html |
(Optional) Contains the mobile library configuration |
manifest.json |
A JSON file containing the information returned by the Revision Details endpoint. Note: The SHA256 for the bundle is not included. |
Error messages
Potential error messages for this task are:
Error Message | Description |
---|---|
400 Not Found | {"returnCode" : 1270, "message" : "The revision bundle requested is not the latest"} |
This page was last updated: June 21, 2024