General
Connatix API is an interface that allows clients to connect, login and download predefined reports.
The following tables lists the formats and conventions used when exchanging data with the API:
Request | |
---|---|
Method | POST / GET |
Target | https://console.connatix.com/api/<connatix_api_endpoint> |
Headers | content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> | |
Body | JSON object (property for each mandatory parameter) |
Server responds with HTTP status code and JSON object with extra information in response body.
Response | |
---|---|
Status | HTTP Status Code |
Headers | set-cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body | Empty or JSON object |
You may encounter the following status codes as a response:
HTTP Status Codes | |
---|---|
200 OK | Request valid |
400 Bad Request |
Incomplete or invalid request, required parameters not supplied |
401 Unauthorized | Invalid credentials or request is missing authorization headers |
404 Not Found | Server could not find the requested resource |
Login
Request | |
---|---|
Method | POST |
Target | https://console.connatix.com/api/account/login |
Headers | content-type: application/json |
Body |
JSON object
{
|
In case of success, server's Response has status code 200 OK. ConnatixAuth authorization cookie is supplied in the response headers.
Important: All subsequent requests must include ConnatixAuth in Cookie request header .
Response | |
---|---|
Status | HTTP Status Code |
Headers | set-cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body | Empty |
EXAMPLE & OUTPUT
curl 'https://console.connatix.com/api/account/Login' -H 'content-type: application/json' --data-binary '{"Username":"demo","Password":"MyAw3550meP@55w0rd"}'
HTTP/1.1 200 OK
Set-Cookie: ConnatixAuth=s_Gnr-L7Cv8uUP0nWreE83nVx2ZPmUGiuhhSN3B7VfCFQyBKmIaj-2c9DiLyesLMWTdpoP2sLJOBRgsafdF6TAAOSHAzdddjyhuTLPWqpdAGLIWgvEMN2E5E5HbyN1-DM_MbM4z104x99bJ8T1ttLPqQKqSL5iQoY9nOxaY7wVH94MU6_WjffL8800naQR0_o5aWGAUhYRr41q5LyvJNxRa1L3E71dxykD-TloxMhDtYbkmeXlZMFBSOGhb_UWURe5pYKu3enYsbcE9cc0B4Jruxoy4nvO3i99-oEQ5uqfuqRgUjVihF_cPzHJiiChX430T_pP6Rk4akJ_H0lykBcTMiKgLY14Gw1oT1LhIGufJA_Dfam5JH1I12wnOPxGrX0uMqW7ZWABB3PD9BARIL9ZFbSOz_GT2wUhy6IbY-fflkugdFaSJK42VIwqc0UYc5aPNMGgdudIzHtc5sX3AsO8914-TbNRC79zw00nrz68LNM2bzUervlibFmf5r4ZxO3PfE1A; domain=.connatix.com; path=/; HttpOnly
Report Download
Request | |
---|---|
Method | GET |
Target |
https://console.connatix.com/api/reports/download/<id> <id>: report identifier (required) |
Headers | content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> | |
Body | Empty |
In case of success, server's response has status code 200 OK and include in the body a JSON object with last refresh timestamp (formatted as yyyy-MM-ddTHH:mm:ssZ) and an URL for downloading the report as a CSV file.
Response | |
---|---|
Status | HTTP Status Code |
Headers | set-cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
{ Timestamp: date string, Url: string}
|
EXAMPLE & OUTPUT
curl -X GET 'https://console.connatix.com/api/reports/download/12356' -H 'content-type: application/json' -H 'Cookie: ConnatixAuth=s_Gnr-L7Cv8uUP0nWreE83nVx2ZPmUGiuhhSN3B7VfCFQyBKmIaj-2c9DiLyesLMWTdpoP2sLJOBRgsafdF6TAAOSHAzdddjyhuTLPWqpdAGLIWgvEMN2E5E5HbyN1-DM_MbM4z104x99bJ8T1ttLPqQKqSL5iQoY9nOxaY7wVH94MU6_WjffL8800naQR0_o5aWGAUhYRr41q5LyvJNxRa1L3E71dxykD-TloxMhDtYbkmeXlZMFBSOGhb_UWURe5pYKu3enYsbcE9cc0B4Jruxoy4nvO3i99-oEQ5uqfuqRgUjVihF_cPzHJiiChX430T_pP6Rk4akJ_H0lykBcTMiKgLY14Gw1oT1LhIGufJA_Dfam5JH1I12wnOPxGrX0uMqW7ZWABB3PD9BARIL9ZFbSOz_GT2wUhy6IbY-fflkugdFaSJK42VIwqc0UYc5aPNMGgdudIzHtc5sX3AsO8914-TbNRC79zw00nrz68LNM2bzUervlibFmf5r4ZxO3PfE1A'
HTTP/1.1 200 OK
{"Url":"https://connatix-reports.s3.amazonaws.com/81F3AB97-745E-48B5-B7A1-556933115B8E.csv?AWSAccessKeyId=ZKIAJ1PM2UCPBTR5Y8RQ\u0026Expires=1495032166\u0026Signature=QGgkWLRLXMXIxIp54LSORGjih60%3D"}
Sites Get
Request | |
---|---|
Method | GET |
Target |
https://console.connatix.com/api/ad/getsites |
Headers | content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Response | |||||||
---|---|---|---|---|---|---|---|
Status | HTTP Status Code | ||||||
Headers | set-cookie: ConnatixAuth=<connatix_auth_cookie_value> | ||||||
Body |
Array of site objects
|
Video Save
Request | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||||||||||||||||||
Target |
https://console.connatix.com/api/videos/savevideo |
||||||||||||||||||||||||
Headers | content-type: application/json | ||||||||||||||||||||||||
cookie: ConnatixAuth=<connatix_auth_cookie_value> | |||||||||||||||||||||||||
Body |
JSON object with properties
|
Response | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status | HTTP Status Code | |||||||||||||||||||||||||||||||||||||||||||||||||
Headers | set-cookie: ConnatixAuth=<connatix_auth_cookie_value> | |||||||||||||||||||||||||||||||||||||||||||||||||
Body |
JSON object with properties
|
Video Get
Request | |
---|---|
Method | GET |
Target |
https://console.connatix.com/api/videos/getvideo/<id> <id>: video identifier (required) |
Headers | content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Response | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status | HTTP Status Code | |||||||||||||||||||||||||||||||||||||||||||||||||
Headers | set-cookie: ConnatixAuth=<connatix_auth_cookie_value> | |||||||||||||||||||||||||||||||||||||||||||||||||
Body |
JSON object with properties
|
Videos Get Status
Request | |||||||
---|---|---|---|---|---|---|---|
Method | POST | ||||||
Target |
https://console.connatix.com/api/videos/getvideostatus |
||||||
Headers | content-type: application/json | ||||||
cookie: ConnatixAuth=<connatix_auth_cookie_value> | |||||||
Body |
Array of objects
|
Response | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status | HTTP Status Code | |||||||||||||||||||||||||||||||||||||
Headers | set-cookie: ConnatixAuth=<connatix_auth_cookie_value> | |||||||||||||||||||||||||||||||||||||
Body |
JSON object with properties
|
Playlist Save
Request | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||||||
Target |
https://console.connatix.com/api/videos/savelist |
||||||||||||
Headers | content-type: application/json | ||||||||||||
cookie: ConnatixAuth=<connatix_auth_cookie_value> | |||||||||||||
Body |
JSON object with properties
|
Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Status | HTTP Status Code | |||||||||
Headers | set-cookie: ConnatixAuth=<connatix_auth_cookie_value> | |||||||||
Body |
JSON object with properties
|
Add to Playlist
Request | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||||||
Target |
https://console.connatix.com/api/videos/addtolist |
||||||||||||
Headers | content-type: application/json | ||||||||||||
cookie: ConnatixAuth=<connatix_auth_cookie_value> | |||||||||||||
Body |
JSON object with properties
|
Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Status | HTTP Status Code | |||||||||
Headers | set-cookie: ConnatixAuth=<connatix_auth_cookie_value> | |||||||||
Body |
JSON object with properties
|
Playlist Get
Request | |
---|---|
Method | GET |
Target |
https://console.connatix.com/api/videos/getlist/<id> <id>: Playlist identifier (required) |
Headers | content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Status | HTTP Status Code | |||||||||
Headers | set-cookie: ConnatixAuth=<connatix_auth_cookie_value> | |||||||||
Body |
JSON object with properties
|
Ad Save
Request | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Method | POST | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Target |
https://console.connatix.com/api/ad/save |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Headers | content-type: application/json | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cookie: ConnatixAuth=<connatix_auth_cookie_value> | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body |
JSON object with properties
|
Response | |||||||
---|---|---|---|---|---|---|---|
Status | HTTP Status Code | ||||||
Headers | set-cookie: ConnatixAuth=<connatix_auth_cookie_value> | ||||||
Body |
JSON object with properties
|
Ad Get
Request | |
---|---|
Method | GET |
Target |
https://console.connatix.com/api/ad/get/<id> <id>: ad identifier (required) |
Headers | content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Response | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status | HTTP Status Code | |||||||||||||||||||||||||||||||||||||||
Headers | set-cookie: ConnatixAuth=<connatix_auth_cookie_value> | |||||||||||||||||||||||||||||||||||||||
Body |
JSON object with properties
|
Ad Clone
Request | |
---|---|
Method | POST |
Target |
https://console.connatix.com/api/ad/clonead |
Headers | content-type: application/json |
cookie: ConnatixAuth=<connatix_auth_cookie_value> | |
Body |
JSON object
{
|
Response | |
---|---|
Status | HTTP Status Code |
Headers | set-cookie: ConnatixAuth=<connatix_auth_cookie_value> |
Body |
{ Success: boolean , Item: string /* GUID token */}
|
EXAMPLE & OUTPUT
curl -X POST 'https://console.connatix.com/api/ad/clonead' -H 'content-type: application/json' -H 'Cookie: ConnatixAuth=s_Gnr-L7Cv8uUP0nWreE83nVx2ZPmUGiuhhSN3B7VfCFQyBKmIaj-2c9DiLyesLMWTdpoP2sLJOBRgsafdF6TAAOSHAzdddjyhuTLPWqpdAGLIWgvEMN2E5E5HbyN1-DM_MbM4z104x99bJ8T1ttLPqQKqSL5iQoY9nOxaY7wVH94MU6_WjffL8800naQR0_o5aWGAUhYRr41q5LyvJNxRa1L3E71dxykD-TloxMhDtYbkmeXlZMFBSOGhb_UWURe5pYKu3enYsbcE9cc0B4Jruxoy4nvO3i99-oEQ5uqfuqRgUjVihF_cPzHJiiChX430T_pP6Rk4akJ_H0lykBcTMiKgLY14Gw1oT1LhIGufJA_Dfam5JH1I12wnOPxGrX0uMqW7ZWABB3PD9BARIL9ZFbSOz_GT2wUhy6IbY-fflkugdFaSJK42VIwqc0UYc5aPNMGgdudIzHtc5sX3AsO8914-TbNRC79zw00nrz68LNM2bzUervlibFmf5r4ZxO3PfE1A' --data-binary '{"id":"9876", "name": "Clone Example", "siteId":"123"}'
HTTP/1.1 200 OK
{ "Success": "true" , "Item": "d41323e2-279d-4450-9cb8-cebb67ce8d88"}
Comments
Please sign in to leave a comment.