Skip to main content
GET
/
attributions
cURL
curl --request GET \
  --url https://api.konvoai.com/attributions \
  --header 'x-api-key: <api-key>'
{
  "count": 123,
  "result": [
    {
      "id": "be6ed223-19c3-47db-8635-794f856e1956",
      "origin": "BROADCAST",
      "originId": "be6ed223-19c3-47db-8635-794f856e1956",
      "externalUserId": "15552345678",
      "orderTotal": 69995,
      "type": "MAIN",
      "createdAt": "2024-08-02T14:58:55.728Z"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
page
integer

Pointer for the current page of the paginated query

​
limit
integer

The maximum number of results to return, maximum is 200

​
fields
string

Comma separated list of fields you want to retrieve from the contact. Omitting this will return all fields. Using this param will speed up requests

​
contact
string

Fetch attributions specifically for one contact by ID

​
created_at_min
string

Filter by attributions created after a certain date

​
created_at_max
string

Filter by attributions created before a certain date

​
type
string

Query by type, with the options MAIN or ASSIST

​
origin
string

Filter by origin within Konvo, with the options being: broadcast, ai, flow, automation, app

​
originId
string

Query by specific origin, where the ID can be from any of the above 'origin' types

​
originIds
string

Comma separated list of origin IDs to include in the query

Response

Get attributions response

​
count
integer

Total count of the request

​
result
object[]

Resulting query