Matchai Docs

Get a listing’s analyticsComing soon

Returns the numbers on the listing’s Analytics tab: views, visitors, engaged time, clicks, where visits came from, and how AI assistants read, show and…

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

Coming soon. Returns the numbers on the listing’s Analytics tab: views, visitors, engaged time, clicks, where visits came from, and how AI assistants read, show and recommend the listing, over 7, 30 or 90 days, compared with the period before.

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

days?integer

Length of the period.

Default30
Value in73090

Response Body

Analytics.

application/json
  1. response

Visits and AI activity for one listing. Days are counted in Eastern time. An AI read is a verified fetch by an AI assistant; an AI referral is a person who clicked through from an assistant’s answer; an AI impression is a listing card shown inside an assistant; an AI recommendation is a verified referral or impression.

listing_id*string

Listing id.

Length1 <= length <= 64
range*
generated_at*string

When these numbers were computed.

Formatdate-time
totals*
previous_totals*

The same totals for the period just before, to compare.

live*
daily*array<>

One entry per day.

audience*
sources*array<>

Where visits came from.

ai_assistants*array<>

Activity per AI assistant.

clicks*array<>

Clicks per call to action.

devices*array<>

Views per device.

countries*array<>

Views per country.

Example Request
curl -X GET 'https://api.matchai.co/v1/listings/string/analytics'
Example Response
{  "listing_id": "string",  "range": {    "from": "2019-08-24",    "to": "2019-08-24",    "days": 7  },  "generated_at": "2019-08-24T14:15:22Z",  "totals": {    "views": 0,    "visitors": 0,    "sessions": 0,    "avg_engaged_seconds": 0,    "clicks": 0,    "ai_reads": 0,    "ai_referrals": 0,    "ai_impressions": 0,    "ai_recommendations": 0  },  "previous_totals": {    "views": 0,    "visitors": 0,    "avg_engaged_seconds": 0,    "ai_reads": 0,    "ai_referrals": 0,    "ai_impressions": 0,    "ai_recommendations": 0  },  "live": {    "visitors_now": 0,    "views_last_30_minutes": 0  },  "daily": [    {      "date": "2019-08-24",      "views": 0,      "visitors": 0,      "ai_reads": 0,      "ai_referrals": 0,      "ai_impressions": 0,      "ai_recommendations": 0    }  ],  "audience": {    "members": 0,    "anonymous": 0,    "unknown": 0  },  "sources": [    {      "class": "ai",      "key": "string",      "views": 0,      "visitors": 0    }  ],  "ai_assistants": [    {      "assistant": "string",      "reads": 0,      "referrals": 0,      "impressions": 0,      "recommendations": 0    }  ],  "clicks": [    {      "target": "call",      "count": 0    }  ],  "devices": [    {      "device": "mobile",      "views": 0    }  ],  "countries": [    {      "country": "string",      "views": 0    }  ]}