Back to docs

API Reference

Integrate GetIntent personalization directly into your applications.

Authentication

All API requests require authentication using your API key in the header:

X-API-Key: YOUR_API_KEY

Find your API key in the dashboard settings.

Base URL

https://api.getintent.co/api

Endpoints

POST/api/v1/personalize

Generate personalized content for a visitor based on UTM parameters

Parameters

NameTypeRequiredDescription
siteIdstringrequiredYour site ID
utm_sourcestringoptionalTraffic source
utm_mediumstringoptionalMarketing medium
utm_campaignstringoptionalCampaign name
utm_termstringoptionalSearch term
utm_contentstringoptionalContent variant

Response

{
  "transformations": [
    {
      "selector": "h1.hero-title",
      "original": "Welcome to our platform",
      "transformed": "The best CRM for startups"
    }
  ],
  "cached": false,
  "generatedAt": "2025-01-13T12:00:00Z"
}
GET/api/v1/sites/:siteId

Get site configuration and settings

Parameters

NameTypeRequiredDescription
siteIdstringrequiredYour site ID (path parameter)

Response

{
  "id": "site_abc123",
  "domain": "example.com",
  "status": "active",
  "personalizationMode": "auto"
}
POST/api/v1/track/pageview

Track a page view with UTM attribution

Parameters

NameTypeRequiredDescription
siteIdstringrequiredYour site ID
urlstringrequiredPage URL
referrerstringoptionalReferrer URL
utm_*stringoptionalUTM parameters

Response

{
  "success": true,
  "pageviewId": "pv_xyz789"
}
POST/api/v1/track/conversion

Track a conversion event

Parameters

NameTypeRequiredDescription
siteIdstringrequiredYour site ID
typestringrequiredConversion type (signup, purchase, etc.)
valuenumberoptionalConversion value
metadataobjectoptionalAdditional metadata

Response

{
  "success": true,
  "conversionId": "conv_abc123"
}

Rate Limits

API requests are rate limited based on your plan:

  • Beta: 100 requests/minute
  • Pro: 1,000 requests/minute
  • Enterprise: Custom limits