As a Premium Publisher API user, you can manage your Kochava apps, campaigns, segments, trackers, and postback triggers without ever logging into the Kochava UI. This powerful API offers the same functionality as the UI and is designed to be used in lieu of the Kochava UI.
NOTE: The Premium Publisher API documentation refers to the trigger for a postback as opposed to the postback, itself. The postback is the payload of data sent, the trigger is the event which causes a postback to be fired.
NOTE: The Premium Publisher API and the Kochava Dashboard function independently.
Creating Triggers
- Use the Get Template call to retrieve valid postback templates for your app.
Returns a list of Postback Templates that are available for the given appId.
Get:
1 | /apps/{appId:int}/postbacks/templates |
Header:
| Field | Type | Description |
|---|---|---|
| Authentication-Key | String | Your Publisher api key. |
Success 200:
| Field | Type | Description |
|---|---|---|
| data | Object[] | A list of Template objects. |
| success | Boolean | Indicates if the request was successful. |
| errors | String[] | A list of errors that occurred while processing the request. |
| messages | String[] | A list of information messages about the request. |
| warnings | String[] | A list of warnings that occurred while processing the request. |
| nextToken | String | A token that is used to retrieve the next page of results, null if not applicable to the request. |
| previousToken | String | A token that is used to retrieve the previous page of results, null if not applicable to the request. |
| meta | Object | Currently not used. |
Sample Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 | HTTP/1.1 200 OK { "success":true, "meta":null, "nextToken":null, "previousToken":null, "errors":[], "warnings":[], "messages":[], "data":[ { "id":2209, "network_id":3, "platform":"", "name":"mmDSP", "context_meta":[ { "label":{ "name":"App ID", "description":"Provided by mmDSP" }, "input":{ "id":"cpi_jumptap_app_id", "type":"text", "required":false, "default_value":"" } }, { "label":{ "name":"Fingerprint Lookback", "description":"The lookback window for fingerprint reconciliation." }, "input":{ "id":"cpi_jumptap_fingerprint_lookback_window", "type":"select", "required":"true", "default_value":"7", "options":[ {"value":1,"label":"1 day"}, {"value":2,"label":"2 days"}, ... ], } }, { "label":{ "description": "Automatically delay postback delivery for this time duration", "name":"Delivery Delay" }, "input":{ "type":"select", "options":[ {"value":0,"label":"Realtime Delivery"}, {"value":30000,"label":"30 Second Delay"}, ... ], "default_value":0, "id": "deferred_for" } }, { "label":{ "description": "Max times to attempt redelivery in event of posting failure", "name":"Retry Attempts" }, "input":{ "type":"select", "options":[ {"value":0,"label":"Do Not Retry"}, {"value":1,"label":"1 Attempt"}, ... ] "default_value":3, "id": "max_delivery_attempts" } } ] }, ... ] } |
HTTP Status Codes:
| Field | Description |
|---|---|
| 401 | The Authentication Key sent with the request is invalid. |
| 403 | The Authentication Key is not authorized to access the requested resource. |
- Create the Trigger.
Creates a new Postback Trigger for the app in the request body.
Post:
1 | /postbacks |
NOTE: The Trigger is the event which causes a postback to be fired.
Header:
| Field | Type | Description |
|---|---|---|
| Authentication-Key | String | Your Publisher api key. |
Success 200:
| Field | Type | Description |
|---|---|---|
| data | Object[] | A list with a single Trigger object. |
| success | Boolean | Indicates if the request was successful. |
| errors | String[] | A list of errors that occurred while processing the request. |
| messages | String[] | A list of information messages about the request. |
| warnings | String[] | A list of warnings that occurred while processing the request. |
| nextToken | String | A token that is used to retrieve the next page of results, null if not applicable to the request. |
| previousToken | String | A token that is used to retrieve the previous page of results, null if not applicable to the request. |
| meta | Object | Currently not used. |
Sample Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | HTTP/1.1 201 OK { "success":true, "meta":null, "nextToken":null, "previousToken":null, "errors":[], "warnings":[], "messages":[], "data":[ { "id":54636, "app_id":17, "type":"event", "title":"OpenX Performance", "template_id":2602, "filter_str": "Purchase". "active":false, "date_created":1394048564, "context":{ "cpi_openxperformance_fingerprint_lookback_window":"7", "cpi_openxperformance_device_id_lookback_window":"30" } } ] } |
HTTP Status Codes:
| Field | Description |
|---|---|
| 401 | The Authentication Key sent with the request is invalid. |
| 400 | The request data has malformed syntax. The request should not be repeated without modifications. A common cause of this is invalid JSON in the request body. |
| 500 | An unexpected server side condition occurred that prevented the request from being fulfilled. This issue is on us so you should try your request again shortly to see if the problem has been resolved. |
- Use the Get Trigger method to verify the Trigger.
Returns a single Postback Trigger with the given id.
Get:
1 | /apps/{appId:int}/postbacks/{id:int} |
Header:
| Field | Type | Description |
|---|---|---|
| Authentication-Key | String | Your Publisher api key. |
Success 200:
| Field | Type | Description |
|---|---|---|
| data | Object[] | A list with a Trigger object. |
| success | Boolean | Indicates if the request was successful. |
| errors | String[] | A list of errors that occurred while processing the request. |
| messages | String[] | A list of information messages about the request. |
| warnings | String[] | A list of warnings that occurred while processing the request. |
| nextToken | String | A token that is used to retrieve the next page of results, null if not applicable to the request. |
| previousToken | String | A token that is used to retrieve the previous page of results, null if not applicable to the request. |
| meta | Object | Currently not used. |
Sample Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 | HTTP/1.1 200 OK { "success":true, "meta":null, "nextToken":null, "previousToken":null, "errors":[], "warnings":[], "messages":[], "data":[ { "id":54636, "app_id":17, "type":"install", "title":"OpenX Performance", "template_id":2602, "active":false, "date_created":1394048564, "context":{ "cpi_openxperformance_fingerprint_lookback_window":"7", "cpi_openxperformance_device_id_lookback_window":"30" } } ] } |
HTTP Status Codes:
| Field | Description |
|---|---|
| 401 | The Authentication Key sent with the request is invalid. |
| 403 | The Authentication Key is not authorized to access the requested resource. |
| 404 | The requested resource/entity was not found. |
Updating Triggers
- Use the Get Pending Setup call to retrieve any incomplete Triggers.
Returns a list of Postback Templates that need to be setup for the given appId.
Get:
1 | /apps/{appId:int}/postbacks/incomplete |
Header:
| Field | Type | Description |
|---|---|---|
| Authentication-Key | String | Your Publisher api key. |
Success 200:
| Field | Type | Description |
|---|---|---|
| data | Object[] | A list with Postback Template objects. |
| success | Boolean | Indicates if the request was successful. |
| errors | String[] | A list of errors that occurred while processing the request. |
| messages | String[] | A list of information messages about the request. |
| warnings | String[] | A list of warnings that occurred while processing the request. |
| nextToken | String | A token that is used to retrieve the next page of results, null if not applicable to the request. |
| previousToken | String | A token that is used to retrieve the previous page of results, null if not applicable to the request. |
| meta | Object | Currently not used. |
Sample Response:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 | HTTP/1.1 200 OK { "success":true, "meta":null, "nextToken":null, "previousToken":null, "errors":[], "warnings":[], "messages":[], "data":[ { "id":2209, "network_id":3, "name":"mmDSP", "platform":"", "context_meta":[ { "label":{ "name":"App ID", "description":"Provided by mmDSP" }, "input":{ "id":"cpi_jumptap_app_id", "type":"text", "required":false, "default_value":"" } }, { "label":{ "name":"Fingerprint Lookback", "description":"The lookback window for fingerprint reconciliation." }, "input":{ "id":"cpi_jumptap_fingerprint_lookback_window", "type":"select", "required":"true", "default_value":"7", "options":[{"value":1,"label":"1 day"},{"value":2,"label":"2 days"}] } } ] }, ... ] } |
HTTP Status Codes:
| Field | Description |
|---|---|
| 401 | The Authentication Key sent with the request is invalid. |
| 403 | The Authentication Key is not authorized to access the requested resource. |
- Using the list of incomplete Triggers, update as needed.
- Use the Get Trigger method to verify the Trigger.
NOTE: The Trigger is the event which causes a postback to be fired.
Deleting Triggers
Deletes a Postback Trigger with the given ID.
Delete:
1 | /postbacks/{id:int} |
Header:
| Field | Type | Description |
|---|---|---|
| Authentication-Key | String | Your Publisher API key. |
Sample Response:
1 | HTTP/1.1 200 OK |
HTTP Status Codes:
| Field | Description |
|---|---|
| 401 | The Authentication Key sent with the request is invalid. |
| 404 | The requested resource/entity was not found. |
| 400 | The request data has malformed syntax. The request should not be repeated without modifications. A common cause of this is invalid JSON in the request body. |
| 500 | An unexpected server side condition occurred that prevented the request from being fulfilled. This issue is on us so you should try your request again shortly to see if the problem has been resolved. |
