{ "openapi": "3.1.1", "info": { "title": "LinkIntelligence.Web | v1", "version": "1.0.0" }, "servers": [ { "url": "https://bgum.me/" } ], "paths": { "/api/admin/runtime": { "get": { "tags": [ "Administration" ], "responses": { "200": { "description": "OK" } } } }, "/api/me": { "get": { "tags": [ "Account" ], "responses": { "200": { "description": "OK" } } } }, "/webhooks/stripe": { "post": { "tags": [ "LinkIntelligence.Web" ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/register": { "post": { "tags": [ "Authentication" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/verify-email": { "post": { "tags": [ "Authentication" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/login": { "post": { "tags": [ "Authentication" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/mfa": { "post": { "tags": [ "Authentication" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/logout": { "post": { "tags": [ "Authentication" ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/forgot-password": { "post": { "tags": [ "Authentication" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/reset-password": { "post": { "tags": [ "Authentication" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/me/mfa": { "get": { "tags": [ "Account" ], "responses": { "200": { "description": "OK" } } } }, "/api/me/mfa/setup": { "post": { "tags": [ "Account" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaPasswordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/me/mfa/enable": { "post": { "tags": [ "Account" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaCodeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/me/mfa/disable": { "post": { "tags": [ "Account" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaCodeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/me/mfa/recovery-codes": { "post": { "tags": [ "Account" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaCodeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/links": { "post": { "tags": [ "Links" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLinkCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Links" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "$ref": "#/components/schemas/LinkEffectiveState" } }, { "name": "tag", "in": "query", "schema": { "type": "string" } }, { "name": "campaignId", "in": "query", "schema": { "type": "string" } }, { "name": "domainId", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/links/bulk": { "post": { "tags": [ "Links" ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/links/{linkId}": { "get": { "tags": [ "Links" ], "parameters": [ { "name": "linkId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "Links" ], "parameters": [ { "name": "linkId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLinkCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Links" ], "parameters": [ { "name": "linkId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/aliases/availability": { "get": { "tags": [ "Links" ], "parameters": [ { "name": "alias", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "domainId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/usage": { "get": { "tags": [ "Usage" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/qr-codes": { "post": { "tags": [ "QR codes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateQrCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "QR codes" ], "parameters": [ { "name": "linkId", "in": "query", "schema": { "type": "string" } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/qr-codes/{qrId}": { "get": { "tags": [ "QR codes" ], "parameters": [ { "name": "qrId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "QR codes" ], "parameters": [ { "name": "qrId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateQrCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "QR codes" ], "parameters": [ { "name": "qrId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/qr-codes/{qrId}/image.{format}": { "get": { "tags": [ "QR codes" ], "parameters": [ { "name": "qrId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "size", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/qr-codes/{qrId}/logo": { "put": { "tags": [ "QR codes" ], "parameters": [ { "name": "qrId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "QR codes" ], "parameters": [ { "name": "qrId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/analytics": { "get": { "tags": [ "Analytics" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "top", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/links/{linkId}/analytics": { "get": { "tags": [ "Analytics" ], "parameters": [ { "name": "linkId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "top", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/analytics/export.csv": { "get": { "tags": [ "Analytics" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "linkId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/campaigns": { "get": { "tags": [ "Campaigns" ], "parameters": [ { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Campaigns" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveCampaignCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/campaigns/{campaignId}": { "get": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveCampaignCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Campaigns" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/domains": { "get": { "tags": [ "Domains" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Domains" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddDomainRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/domains/{domainId}": { "get": { "tags": [ "Domains" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Domains" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/domains/{domainId}/check": { "post": { "tags": [ "Domains" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/workspaces/{workspaceId}/domains/{domainId}/redirects": { "put": { "tags": [ "Domains" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedirectsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AddDomainRequest": { "required": [ "hostname" ], "type": "object", "properties": { "hostname": { "type": "string" } } }, "BulkCreateRequest": { "required": [ "links" ], "type": "object", "properties": { "links": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CreateLinkCommand" } } } }, "CreateLinkCommand": { "required": [ "destinationUrl" ], "type": "object", "properties": { "destinationUrl": { "type": "string" }, "domainId": { "type": [ "null", "string" ] }, "alias": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "campaignId": { "type": [ "null", "string" ] }, "startsAt": { "type": [ "null", "string" ], "format": "date-time" }, "endsAt": { "type": [ "null", "string" ], "format": "date-time" }, "draft": { "type": "boolean" }, "redirectType": { "$ref": "#/components/schemas/RedirectType" }, "password": { "type": [ "null", "string" ] }, "idempotencyKey": { "type": [ "null", "string" ] } } }, "CreateQrCommand": { "required": [ "linkId" ], "type": "object", "properties": { "linkId": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "foreground": { "type": [ "null", "string" ] }, "background": { "type": [ "null", "string" ] }, "errorCorrection": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/QrErrorCorrection" } ] }, "quietZone": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "ForgotRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } } }, "LinkEffectiveState": { "enum": [ "Draft", "Scheduled", "Active", "Paused", "Expired", "Archived", "Deleted", null ] }, "LinkStatus": { "enum": [ "Draft", "Active", "Paused", "Archived", null ] }, "LoginRequest": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } } }, "MfaCodeRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" } } }, "MfaPasswordRequest": { "required": [ "password" ], "type": "object", "properties": { "password": { "type": "string" } } }, "MfaRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" } } }, "QrErrorCorrection": { "enum": [ "Low", "Medium", "Quartile", "High", null ] }, "RedirectsRequest": { "required": [ "rootRedirectUrl", "notFoundRedirectUrl" ], "type": "object", "properties": { "rootRedirectUrl": { "type": [ "null", "string" ] }, "notFoundRedirectUrl": { "type": [ "null", "string" ] } } }, "RedirectType": { "enum": [ "MovedPermanently", "Found", "TemporaryRedirect" ] }, "RegisterRequest": { "required": [ "email", "password", "displayName" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "displayName": { "type": [ "null", "string" ] } } }, "ResetRequest": { "required": [ "token", "password" ], "type": "object", "properties": { "token": { "type": "string" }, "password": { "type": "string" } } }, "SaveCampaignCommand": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "utmSource": { "type": [ "null", "string" ] }, "utmMedium": { "type": [ "null", "string" ] }, "utmCampaign": { "type": [ "null", "string" ] } } }, "TokenRequest": { "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string" } } }, "UpdateLinkCommand": { "type": "object", "properties": { "destinationUrl": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "tags": { "type": [ "null", "array" ], "items": { "type": "string" } }, "campaignId": { "type": [ "null", "string" ] }, "clearCampaign": { "type": "boolean" }, "startsAt": { "type": [ "null", "string" ], "format": "date-time" }, "endsAt": { "type": [ "null", "string" ], "format": "date-time" }, "clearSchedule": { "type": "boolean" }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LinkStatus" } ] }, "redirectType": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RedirectType" } ] }, "password": { "type": [ "null", "string" ] }, "removePassword": { "type": "boolean" }, "expectedVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "UpdateQrCommand": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "foreground": { "type": [ "null", "string" ] }, "background": { "type": [ "null", "string" ] }, "errorCorrection": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/QrErrorCorrection" } ] }, "quietZone": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } } } }, "tags": [ { "name": "Administration" }, { "name": "Account" }, { "name": "LinkIntelligence.Web" }, { "name": "Authentication" }, { "name": "Links" }, { "name": "Usage" }, { "name": "QR codes" }, { "name": "Analytics" }, { "name": "Campaigns" }, { "name": "Domains" } ] }