Chilkat Online Tools

Ruby / CleverTap API / Get Message Reports API

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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 = Chilkat::CkJsonObject.new()
json.UpdateString("from","20180111")
json.UpdateString("to","20181030")
json.UpdateBool("daily",false)
json.UpdateString("channel[0]","push")
json.UpdateString("delivery[0]","inaction")
json.UpdateString("delivery[1]","action")
json.UpdateString("status[0]","completed")
json.UpdateString("message_type[0]","single")
json.UpdateNewArray("label")

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

# resp is a CkHttpResponse
resp = http.PostJson3("https://api.clevertap.com/1/message/report.json","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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": [
  ]
}