# Hoko

Hoko is a link attribution platform for creating branded short links, tracking clicks, and connecting leads and sales to the campaigns that produced them.

## Primary Machine-Readable Resources

- Full LLM context: https://hoko.to/llms-full.txt
- OpenAPI: https://hoko.to/openapi.json
- MCP endpoint: https://hoko.to/mcp
- API LLM context: https://hoko.to/api/llms.txt
- API full context: https://hoko.to/api/llms-full.txt
- Docs LLM context: https://hoko.to/docs/llms.txt
- Help LLM context: https://hoko.to/help/llms.txt
- Sitemap index: https://hoko.to/sitemap.xml

## API Endpoint Inventory

| Method | Path | Scope | Purpose |
| --- | --- | --- | --- |
| GET | /api/links | linksRead | List links by id, externalId, tenantId, partnerId, and pagination parameters. |
| POST | /api/links | linksWrite | Create one or more short links. |
| PUT | /api/links | linksWrite | Create or update links; entries with id update, entries without id insert. |
| DELETE | /api/links | linksWrite | Soft-delete one or more links by UUID. |
| GET | /api/collections | collectionsRead | List collections by id with pagination. |
| POST/PUT/DELETE | /api/collections | collectionsWrite | Create, upsert, or soft-delete collections. |
| GET | /api/tags | tagsRead | List tags by id with pagination. |
| POST/PUT/DELETE | /api/tags | tagsWrite | Create, upsert, or delete tags. |
| GET | /api/partners | partnersRead | List partners by id with pagination. |
| POST/PUT/DELETE | /api/partners | partnersWrite | Create, upsert, or soft-delete partners. |
| GET | /api/customers | customersRead | List customers by id or externalId with pagination. |
| GET | /api/analytics | analyticsRead | List click analytics by linkId, partnerId, startDate, endDate, and pagination parameters. |
| POST | /api/track/lead | conversionsWrite | Record a lead conversion and upsert the customer. |
| POST | /api/track/sale | conversionsWrite | Record a sale conversion and upsert the customer. |

## Documentation

### Getting Started

- [Introduction](https://hoko.to/docs/introduction)
  Hoko is a modern link attribution platform that empowers you to create branded short links, track conversions end-to-end, and measure marketing performance with precision.
- [API Keys](https://hoko.to/docs/api-keys)
  Create and manage API keys with granular permission scopes. Secure your integrations with the principle of least privilege.
- [Authentication](https://hoko.to/docs/authentication)
  Secure your API requests with Bearer token authentication. All endpoints require a valid API key in the Authorization header.
- [Rate Limits](https://hoko.to/docs/rate-limits)
  Understand rate limits, monitor your usage, and implement proper retry logic to ensure reliable API access.
- [Errors](https://hoko.to/docs/errors)
  Understand error responses, status codes, and how to handle API errors gracefully in your applications.

### Links

- [Introduction](https://hoko.to/docs/links/introduction)
  The Links API is the foundation of Hoko, enabling you to create, manage, and track short links programmatically.
- [(GET) Get links](https://hoko.to/docs/links/get)
  Retrieve links from your workspace with flexible filtering options. Filter by link ID, external ID, tenant ID, or partner ID.
- [(POST) Create links](https://hoko.to/docs/links/post)
  Create one or more links in a single request. Each link requires a destination URL and collection ID.
- [(PUT) Update/Upsert links](https://hoko.to/docs/links/put)
  Update existing links or create new ones with upsert operations. Perfect for synchronization scenarios.
- [(DELETE) Delete links](https://hoko.to/docs/links/delete)
  Delete one or more links using soft delete. Historical analytics data is preserved.

### Collections

- [Introduction](https://hoko.to/docs/collections/introduction)
  Organize your links with collections. Collections are essential organizational units that help you structure and manage your link library.
- [(GET) Get collections](https://hoko.to/docs/collections/get)
  Retrieve collections from your workspace. Filter by collection ID or list all collections with pagination.
- [(POST) Create collections](https://hoko.to/docs/collections/post)
  Create one or more collections to organize your links. Each collection requires a name.
- [(PUT) Update/Upsert collections](https://hoko.to/docs/collections/put)
  Update existing collections or create new ones with upsert operations.
- [(DELETE) Delete collections](https://hoko.to/docs/collections/delete)
  Delete one or more collections using soft delete.

### Tags

- [Introduction](https://hoko.to/docs/tags/introduction)
  Create, read, update, and delete tags for categorizing and organizing your links.
- [(GET) Get tags](https://hoko.to/docs/tags/get)
  Retrieve tags from your workspace. Filter by tag ID or list all tags with pagination.
- [(POST) Create tags](https://hoko.to/docs/tags/post)
  Create one or more tags. Each tag requires a name, and color is optional.
- [(PUT) Update/Upsert tags](https://hoko.to/docs/tags/put)
  Update existing tags or create new ones with upsert operations.
- [(DELETE) Delete tags](https://hoko.to/docs/tags/delete)
  Permanently delete one or more tags (hard delete).

### Analytics

- [Introduction](https://hoko.to/docs/analytics/introduction)
  Retrieve click analytics and performance data for your links. Gain insights into traffic patterns, user behavior, and campaign effectiveness.
- [(GET) Get analytics](https://hoko.to/docs/analytics/get)
  Retrieve click analytics and performance data for your links. Filter by link, partner, or date range.

### Customers

- [Introduction](https://hoko.to/docs/customers/introduction)
  Read customer data. Customer creation and updates are handled automatically through conversion tracking endpoints.
- [(GET) Get customers](https://hoko.to/docs/customers/get)
  Retrieve customers by ID or external ID. Supports pagination and sorting.

### Partners

- [Introduction](https://hoko.to/docs/partners/introduction)
  Create, read, update, and delete partners for attribution tracking and commission management.
- [(GET) Get partners](https://hoko.to/docs/partners/get)
  Retrieve partners by ID. Supports pagination and sorting.
- [(POST) Create partners](https://hoko.to/docs/partners/post)
  Create one or more partners. Each partner requires a name.
- [(PUT) Update/Upsert partners](https://hoko.to/docs/partners/put)
  Update existing partners or create new ones with upsert operations.
- [(DELETE) Delete partners](https://hoko.to/docs/partners/delete)
  Delete one or more partners using soft delete.

### Conversion Tracking

- [Introduction](https://hoko.to/docs/track/introduction)
  Track lead and sale conversion events to connect marketing touchpoints to business outcomes. Automatically create and update customer records with flexible attribution tracking.
- [Browser attribution script (analytics.js)](https://hoko.to/docs/track/analytics-js)
  Persist the clickId from short-link redirects using analytics.js and send it to conversion endpoints.
- [Embedded click tracking](https://hoko.to/docs/track/embedded-click)
  Track a Hoko short-link click from an owned page without redirecting the visitor.
- [Track lead events](https://hoko.to/docs/track/lead)
- [Track sale events](https://hoko.to/docs/track/sale)

## Help

### Help

- [Getting started](https://hoko.to/help/getting-started)
- [Profile](https://hoko.to/help/profile)
- [Workspaces](https://hoko.to/help/workspaces)
- [Collections](https://hoko.to/help/collections)
- [Links](https://hoko.to/help/links)
- [Tags](https://hoko.to/help/tags)
- [Partners](https://hoko.to/help/partners)
- [UTM templates](https://hoko.to/help/utm-templates)
- [Analytics](https://hoko.to/help/analytics)
- [Participants](https://hoko.to/help/participants)
- [API keys](https://hoko.to/help/api-keys)
- [Billing](https://hoko.to/help/billing)
- [Storage](https://hoko.to/help/storage)
- [Security](https://hoko.to/help/security)