Холбоос

Богино холбоос үүсгэх, унших, засах, устгах (олноор эсвэл ганцаарчлан).

GET/v1/workspaces/{workspaceId}/links

List links, newest first by default, with filters and cursor pagination.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.read

Параметр (16)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`domain`	query	string
`tagIds`	query	string
`tagNames`	query	string
`folderId`	query	string
`search`	query	string
`userId`	query	string
`tenantId`	query	string
`externalId`	query	string
`showArchived`	query	boolean
`sortBy`	query	string		`createdAt` (default), `clicks` or `lastClicked`.
`sortOrder`	query	string		`desc` (default) or `asc`.
`pageSize`	query	integer (int32)
`startingAfter`	query	string
`endingBefore`	query	string
`groupBy`	query	string		Count only: `domain`, `tagId`, `userId` or `folderId`.

Хариу: 200 LinkDto[]

POST/v1/workspaces/{workspaceId}/links

Create a link. The domain defaults to the primary domain, the key to a random one; a taken (domain, key) is 409.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (LinkInput)

Нэр	Төрөл	Тайлбар
`url`	string
`domain`	string
`key`	string
`keyLength`	integer (int64)
`prefix`	string
`externalId`	string
`tenantId`	string
`programId`	string
`partnerId`	string
`trackConversion`	boolean
`archived`	boolean
`tagIds`	array
`tagNames`	array
`folderId`	string
`comments`	string
`expiresAt`	string
`expiredUrl`	string
`password`	string	Write-only: a new password, or `null` to remove it.
`proxy`	boolean
`title`	string
`description`	string
`image`	string
`video`	string
`rewrite`	boolean
`ios`	string
`geo`	object
`doIndex`	boolean
`android`	string
`utm_source`	string
`utm_medium`	string
`utm_campaign`	string
`utm_term`	string
`utm_content`	string
`ref`	string
`testVariants`	array
`testStartedAt`	string
`testCompletedAt`	string

Хариу: 200 LinkDto

GET/v1/workspaces/{workspaceId}/links/availability

Check whether a custom key is free on a domain (format, reserved list, existing links).

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.read

Параметр (3)

Нэр	Байрлал	Төрөл	Заавал
`workspaceId`	path	string	тийм
`domain`	query	string
`key`	query	string	тийм

Хариу: 200 Availability

POST/v1/workspaces/{workspaceId}/links/bulk

Create up to 100 links; the response is aligned with the input and each element is the created link or {link, error, code}. No custom previews, no webhooks.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хариу: 200 object[]

PATCH/v1/workspaces/{workspaceId}/links/bulk

Apply the same changes to up to 100 links by linkIds or externalIds.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (BulkUpdateBody)

Нэр	Төрөл	Заавал	Тайлбар
`linkIds`	array
`externalIds`	array
`data`	LinkInput	тийм	Create, upsert, update and bulk-update body. Every field is optional; `url` is required by create and upsert.

Хариу: 200 LinkDto[]

DELETE/v1/workspaces/{workspaceId}/links/bulk

Delete up to 100 links permanently; unknown ids are ignored.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`linkIds`	query	string	тийм	Comma separated link ids (at most 100).

Хариу: 200 DeletedCount

GET/v1/workspaces/{workspaceId}/links/count

Count links with the list filters; groupBy returns [{group, count}].

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.read

Параметр (16)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`domain`	query	string
`tagIds`	query	string
`tagNames`	query	string
`folderId`	query	string
`search`	query	string
`userId`	query	string
`tenantId`	query	string
`externalId`	query	string
`showArchived`	query	boolean
`sortBy`	query	string		`createdAt` (default), `clicks` or `lastClicked`.
`sortOrder`	query	string		`desc` (default) or `asc`.
`pageSize`	query	integer (int32)
`startingAfter`	query	string
`endingBefore`	query	string
`groupBy`	query	string		Count only: `domain`, `tagId`, `userId` or `folderId`.

Хариу: 200 object

POST/v1/workspaces/{workspaceId}/links/export

Start a CSV export: date range, column selection and the current filters.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (ExportBody)

Нэр	Төрөл	Тайлбар
`columns`	array	Columns in order; default `shortLink, url, clicks, createdAt`.
`from`	string (date-time)	Only links created at or after / before these instants.
`to`	string (date-time)
`filters`	null \| Filters

Хариу: 202 JobDto

POST/v1/workspaces/{workspaceId}/links/import

Start a CSV import. The job skips rows whose (domain, key) exists, rejects domains the workspace does not own and reports row errors in a CSV file.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (ImportBody)

Нэр	Төрөл	Заавал	Тайлбар
`csv`	string	тийм	The CSV text (header row required).
`mapping`	null \| ImportMapping

Хариу: 202 JobDto

POST/v1/workspaces/{workspaceId}/links/import/file

Start a CSV import from a raw text/csv body of up to 12 MB (the JSON form is limited by the 1 MB request cap). Same rules and job as POST /links/import.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (7)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`urlColumn`	query	string		Header names of the columns; omitted columns are matched by name.
`shortLinkColumn`	query	string
`titleColumn`	query	string
`descriptionColumn`	query	string
`tagsColumn`	query	string
`createdAtColumn`	query	string

Хариу: 202 JobDto

GET/v1/workspaces/{workspaceId}/links/info

Fetch one link by id, external id or (domain, key).

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.read

Параметр (5)

Нэр	Байрлал	Төрөл	Заавал
`workspaceId`	path	string	тийм
`linkId`	query	string
`externalId`	query	string
`domain`	query	string
`key`	query	string

Хариу: 200 LinkDto

GET/v1/workspaces/{workspaceId}/links/jobs

Import and export jobs of the workspace (yours; owners and admins see all), newest first.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.read

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хариу: 200 JobDto[]

GET/v1/workspaces/{workspaceId}/links/jobs/{jobId}

One import or export job with its progress.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`jobId`	path	string	тийм

Хариу: 200 JobDto

GET/v1/workspaces/{workspaceId}/links/jobs/{jobId}/download

Download the result CSV of an export or the error CSV of an import.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.read

Параметр (3)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`jobId`	path	string	тийм
`file`	query	string		`result` (default) or `errors`.

Хариу: 200

POST/v1/workspaces/{workspaceId}/links/operations

Run an action over every link matching the filter: a job that walks the filter in chunks of 100, skipping links the caller may not edit, and reports matched, changed, skipped and failed counts in its progress.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (BulkOperationBody)

Нэр	Төрөл	Заавал	Тайлбар
`operation`	string	тийм	`archive`, `unarchive`, `delete`, `track_conversion`, `tags` or `move`.
`filters`	null \| Filters
`enabled`	boolean		`track_conversion`: the new value.
`addTagIds`	string[]
`removeTagIds`	string[]
`folderId`	string		`move`: destination folder id, or null to unfile.

Хариу: 202 JobDto

GET/v1/workspaces/{workspaceId}/links/random-key

Propose a free random key (the dashboard's random-slug button, rule 8).

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.read

Параметр (4)

Нэр	Байрлал	Төрөл	Заавал
`workspaceId`	path	string	тийм
`domain`	query	string
`keyLength`	query	integer (int64)
`prefix`	query	string

Хариу: 200 RandomKey

PUT/v1/workspaces/{workspaceId}/links/upsert

Return the link matching the destination (updating changed fields) or create it.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (LinkInput)

Нэр	Төрөл	Тайлбар
`url`	string
`domain`	string
`key`	string
`keyLength`	integer (int64)
`prefix`	string
`externalId`	string
`tenantId`	string
`programId`	string
`partnerId`	string
`trackConversion`	boolean
`archived`	boolean
`tagIds`	array
`tagNames`	array
`folderId`	string
`comments`	string
`expiresAt`	string
`expiredUrl`	string
`password`	string	Write-only: a new password, or `null` to remove it.
`proxy`	boolean
`title`	string
`description`	string
`image`	string
`video`	string
`rewrite`	boolean
`ios`	string
`geo`	object
`doIndex`	boolean
`android`	string
`utm_source`	string
`utm_medium`	string
`utm_campaign`	string
`utm_term`	string
`utm_content`	string
`ref`	string
`testVariants`	array
`testStartedAt`	string
`testCompletedAt`	string

Хариу: 200 LinkDto

GET/v1/workspaces/{workspaceId}/links/{linkId}

Fetch one link by id or ext_<externalId>.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`linkId`	path	string	тийм

Хариу: 200 LinkDto

PATCH/v1/workspaces/{workspaceId}/links/{linkId}

Update a link; only the supplied fields change, an identical request is a no-op.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`linkId`	path	string	тийм

Хүсэлтийн бие (LinkInput)

Нэр	Төрөл	Тайлбар
`url`	string
`domain`	string
`key`	string
`keyLength`	integer (int64)
`prefix`	string
`externalId`	string
`tenantId`	string
`programId`	string
`partnerId`	string
`trackConversion`	boolean
`archived`	boolean
`tagIds`	array
`tagNames`	array
`folderId`	string
`comments`	string
`expiresAt`	string
`expiredUrl`	string
`password`	string	Write-only: a new password, or `null` to remove it.
`proxy`	boolean
`title`	string
`description`	string
`image`	string
`video`	string
`rewrite`	boolean
`ios`	string
`geo`	object
`doIndex`	boolean
`android`	string
`utm_source`	string
`utm_medium`	string
`utm_campaign`	string
`utm_term`	string
`utm_content`	string
`ref`	string
`testVariants`	array
`testStartedAt`	string
`testCompletedAt`	string

Хариу: 200 LinkDto

DELETE/v1/workspaces/{workspaceId}/links/{linkId}

Delete one link permanently.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`linkId`	path	string	тийм

Хариу: 200 IdResult

GET/v1/workspaces/{workspaceId}/links/{linkId}/ab-stats

Per-destination results of the A/B test of a link: configured and observed traffic share, clicks, leads and sales within the test window.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`linkId`	path	string	тийм

Хариу: 200 AbStatDto[]

POST/v1/workspaces/{workspaceId}/links/{linkId}/transfer

Move one link on a shared domain to another workspace (irreversible; statistics reset, tags and folder are not carried; the short link stays the same).

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`linkId`	path	string	тийм

Хүсэлтийн бие (TransferBody)

Нэр	Төрөл	Заавал	Тайлбар
`workspaceId`	string	тийм	Target workspace: `ws_` id or slug. The caller must be able to manage links there.

Хариу: 200 LinkDto

GET/v1/workspaces/{workspaceId}/utm-templates

UTM templates of the workspace, by name.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.read

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хариу: 200 UtmTemplateDto[]

POST/v1/workspaces/{workspaceId}/utm-templates

Create a UTM template.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (UtmTemplateInput)

Нэр	Төрөл	Заавал	Тайлбар
`name`	string
`utm_source`	string
`utm_medium`	string
`utm_campaign`	string
`utm_term`	string
`utm_content`	string
`ref`	string

Хариу: 201 UtmTemplateDto

PATCH/v1/workspaces/{workspaceId}/utm-templates/{templateId}

Edit a template; links that used it are unchanged.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`templateId`	path	string	тийм

Хүсэлтийн бие (UtmTemplateInput)

Нэр	Төрөл	Заавал	Тайлбар
`name`	string
`utm_source`	string
`utm_medium`	string
`utm_campaign`	string
`utm_term`	string
`utm_content`	string
`ref`	string

Хариу: 200 UtmTemplateDto

DELETE/v1/workspaces/{workspaceId}/utm-templates/{templateId}

Delete a template.

Шаардлагатай API түлхүүрийн хамрах хүрээ: links.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`templateId`	path	string	тийм

Хариу: 204