Matchai Docs

List AI activity on a listingComing soon

Returns each time an AI assistant read, showed or sent someone to the listing, newest first, and whether Matchai verified it.

Coming soon. This is documented ahead of launch so you can plan your integration; it is not available yet.
GET
/listings/{listing_id}/analytics/ai-events

Coming soon. Returns each time an AI assistant read, showed or sent someone to the listing, newest first, and whether Matchai verified it.

Scopes: analytics:read

Pricing: Included with the connection.

Authorization

headerAuthorizationBearer <matchai_<base62>>

A personal API key, sent as Authorization: Bearer matchai_…. Create keys in Matchai under Settings → Connectors → Advanced (for developers). A key starts with matchai_ followed by letters and digits, carries the scopes chosen when it was created, and can be revoked at any time. Keys reach only the account that created them: to serve other professionals, use Connect with Matchai.

Scope: analytics:read

Path Parameters

listing_id*string

Listing id, or its slug.

Length1 <= length <= 200

Query Parameters

limit?integer

How many results per page.

Range1 <= value <= 100
Default25
cursor?string

The next_cursor of the previous page. Cursors expire after 24 hours.

Lengthlength <= 512
kind?string

Only this kind.

Value in"read""referral""impression""index""agent_visit"

Response Body

One page of AI events.

application/json
  1. response

One page of results. Pass next_cursor as cursor to get the next page; it is null on the last page.

data*array<>
next_cursor*|

Cursor for the next page, or null when there are no more results.

Example Request
curl -X GET 'https://api.matchai.co/v1/listings/string/analytics/ai-events'
Example Response
{  "data": [    {      "id": "string",      "occurred_at": "2019-08-24T14:15:22Z",      "kind": "read",      "assistant": "string",      "verified": true,      "path": "string"    }  ],  "next_cursor": "string"}