API REFERENCE
Pull Notification
1 min
{ "name" "events", "method" "get", "url" "api klavi ai/data/analysis/v1/events", "description" "if the partner wants to query events through polling, use this endpoint ", "tab" "examples", "examples" { "languages" \[ { "id" "de6wglx4kzhyfakaft9oo", "language" "curl", "code" "curl location 'api klavi ai/data/analysis/v1/events' \\\\\n header 'secretkey string'", "customlabel" "" }, { "id" "ze1ne566aoatwqpd53icy", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'api klavi ai/data/analysis/v1/events',\n 'headers' {\n 'secretkey' 'string'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "2eopch75kpqznk8dhnc3y", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"secretkey\\", \\"string\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"api klavi ai/data/analysis/v1/events\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "z2gm3rt41aacmcj5fbtbv", "language" "python", "code" "import requests\n\nurl = \\"api klavi ai/data/analysis/v1/events\\"\n\npayload = {}\nheaders = {\n 'secretkey' 'string'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "rylyz6faofathcjkkakiz", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"api klavi ai/data/analysis/v1/events\\")\n\nhttp = net http new(url host, url port);\nrequest = net http get new(url)\nrequest\[\\"secretkey\\"] = \\"string\\"\n\nresponse = http request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "de6wglx4kzhyfakaft9oo" }, "results" { "languages" \[ { "id" "co9tpfywzbh2xjry4zg8j", "language" "200", "customlabel" "", "code" "{\n \\"partnerappid\\" \\"12345678\\",\n \\"eventid\\" \\"1495468585434 0e73d1719173766fe4dfe1a8\\",\n \\"eventtype\\" \\"analysis\\",\n \\"eventname\\" \\"analysis finished\\",\n \\"eventtime\\" \\"2025 02 26t20 08 17 848z\\",\n \\"payload\\" {\n \\"batchid\\" \\"25872252137\\",\n \\"presignedurl\\" \\"https //amzn s3 demo bucket s3 us west 2 amazonaws com/key?x amz algorithm=aws4 hmac sha256\&x amz credential=akiaexample123456789%2f20210621%2fus west 2%2fs3%2faws4 request\&x amz date=20210621t041609z\&x amz expires=3600\&x amz signedheaders=host\&x amz signature=examble1234494d5fba3fed607f98018e1dfc62e2529ae96d844123456\\"\n }\n}" }, { "id" "uw g3uncljargsid oxmg", "language" "201", "code" "{\n \\"statuscode\\" 201,\n \\"message\\" \\"no new event\\"\n}", "customlabel" "" }, { "id" "ucsxyn j9i9fnzfxc5odo", "language" "401", "code" "{\n \\"statuscode\\" 401,\n \\"error\\" \\"unauthorized\\",\n \\"message\\" \\"invalid accesskey or secretkey\\"\n}", "customlabel" "" } ], "selectedlanguageid" "co9tpfywzbh2xjry4zg8j" }, "request" { "pathparameters" \[], "queryparameters" \[], "headerparameters" \[ { "name" "secretkey", "kind" "required", "type" "string", "description" "secret key", "" "secret key" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "header parameter", "value" "headerparameters" }, "hastryitout" false, "response" \[ { "name" "partnerappid", "kind" "optional", "type" "string", "description" "unique identifier for partner" }, { "name" "eventid", "kind" "optional", "type" "string", "description" "unique identifier for the event", "children" \[] }, { "name" "eventtype", "kind" "optional", "type" "string", "description" "this case is a fixed string analysis", "children" \[] }, { "name" "eventname", "kind" "optional", "type" "string", "description" "the name of each event", "children" \[] }, { "name" "eventtime", "kind" "optional", "type" "string", "description" "the time when this event was triggered(utc timezone)", "children" \[] }, { "name" "payload", "kind" "optional", "type" "object", "description" "payload object", "children" \[ { "name" "batchid", "kind" "optional", "type" "string", "description" "unique batch identifier" }, { "name" "presignedurl", "kind" "optional", "type" "string", "description" "presigned url" } ] } ] }