Chilkat Online Tools

PureBasic / CleverTap API / Get Message Reports API

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "from": "20180111",
    ;   "to": "20181030",
    ;   "daily": false,
    ;   "channel": [
    ;     "push"
    ;   ],
    ;   "delivery": [
    ;     "inaction",
    ;     "action"
    ;   ],
    ;   "status": [
    ;     "completed"
    ;   ],
    ;   "message_type": [
    ;     "single"
    ;   ],
    ;   "label": [
    ;   ]
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"from","20180111")
    CkJsonObject::ckUpdateString(json,"to","20181030")
    CkJsonObject::ckUpdateBool(json,"daily",0)
    CkJsonObject::ckUpdateString(json,"channel[0]","push")
    CkJsonObject::ckUpdateString(json,"delivery[0]","inaction")
    CkJsonObject::ckUpdateString(json,"delivery[1]","action")
    CkJsonObject::ckUpdateString(json,"status[0]","completed")
    CkJsonObject::ckUpdateString(json,"message_type[0]","single")
    CkJsonObject::ckUpdateNewArray(json,"label")

    CkHttp::ckSetRequestHeader(http,"X-CleverTap-Passcode","{{passcode}}")
    CkHttp::ckSetRequestHeader(http,"X-CleverTap-Account-Id","{{id}}")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    resp.i = CkHttp::ckPostJson3(http,"https://api.clevertap.com/1/message/report.json","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "X-CleverTap-Account-Id: {{id}}"
	-H "X-CleverTap-Passcode: {{passcode}}"
	-H "Content-Type: application/json"
	-d '{
   "from":"20180111",
   "to":"20181030",
   "daily":false,
   "channel":[
    "push"
   ],
   "delivery":[
    "inaction", "action"
   ],
   "status":[
    "completed"
   ],
   "message_type":[
    "single"
   ],
   "label":[
   ]
}'
https://api.clevertap.com/1/message/report.json

Postman Collection Item JSON

{
  "name": "Get Message Reports API",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "X-CleverTap-Account-Id",
        "value": "{{id}}"
      },
      {
        "key": "X-CleverTap-Passcode",
        "value": "{{passcode}}"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n   \"from\":\"20180111\",\n   \"to\":\"20181030\",\n   \"daily\":false,\n   \"channel\":[\n    \"push\"\n   ],\n   \"delivery\":[\n    \"inaction\", \"action\"\n   ],\n   \"status\":[\n    \"completed\"\n   ],\n   \"message_type\":[\n    \"single\"\n   ],\n   \"label\":[\n   ]\n}"
    },
    "url": {
      "raw": "https://api.clevertap.com/1/message/report.json",
      "protocol": "https",
      "host": [
        "api",
        "clevertap",
        "com"
      ],
      "path": [
        "1",
        "message",
        "report.json"
      ]
    }
  },
  "response": [
  ]
}