Skip to main content
GET
/
clicks
cURL
curl --request GET \
  --url https://api.konvoai.com/clicks \
  --header 'x-api-key: <api-key>'
{
  "count": 123,
  "result": [
    {
      "ip_address": "127.0.0.1",
      "device": "Applemobile",
      "operating_system": "iOS",
      "browser": "Chrome",
      "country": "DE",
      "region": "BE",
      "city": "Berlin",
      "lat_long": "52.5363,13.4169",
      "timezone": "Europe/Berlin",
      "id": "1d2686c1-7342-475a-ba38-e13364807343",
      "workspace_id": "fb58e7a6-ae93-4adb-ba11-bae1a6d574d7",
      "channel": "whatsapp",
      "resource_id": "u0IwaLEG1a",
      "external_user_id": "15557368765",
      "contact_id": "dda91016-f97b-4f04-a696-27ddbd15ef27",
      "created_at": "2024-08-02T12:31:25.749Z"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
created_at_min
string

Filter by clicks occurring after a certain date

​
created_at_max
string

Filter by clicks occurring before a certain date

​
contact
string

Fetch attributions specifically for one contact by ID

​
originId
string

Query by specific origin ID (Broadcast, Flow)

Response

Get clicks response

​
count
integer

Total count of the request

​
result
object[]

Resulting query