38079 lines
1.0 MiB
Plaintext
38079 lines
1.0 MiB
Plaintext
{
|
|
"components": {
|
|
"responses": {
|
|
"BadRequestResponse": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"ForbiddenResponse": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "forbidden",
|
|
"message": "Forbidden.",
|
|
"status": 403
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Forbidden."
|
|
},
|
|
"NotFoundResponse": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
},
|
|
"PayloadTooLargeResponse": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "payload-too-large",
|
|
"message": "Payload too large.",
|
|
"status": 413
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Payload too large."
|
|
},
|
|
"ServerErrorResponse": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "server-error",
|
|
"message": "Server error.",
|
|
"status": 500
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Server error."
|
|
},
|
|
"ServiceUnavailableResponse": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service-unavailable",
|
|
"message": "Service unavailable.",
|
|
"status": 503
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Service unavailable."
|
|
},
|
|
"UnauthorizedResponse": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"schemas": {
|
|
"ActiveVisitors": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"visitors": {
|
|
"maximum": 9007199254740991,
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"visitors"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"ApiError": {
|
|
"additionalProperties": false,
|
|
"description": "Standard Umami API error response.",
|
|
"properties": {
|
|
"error": {
|
|
"additionalProperties": {},
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"maximum": 9007199254740991,
|
|
"minimum": -9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"message",
|
|
"code",
|
|
"status"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"error"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"CreateWebsiteRequest": {
|
|
"properties": {
|
|
"domain": {
|
|
"maxLength": 500,
|
|
"pattern": "^(localhost(:[1-9]\\d{0,4})?|((?=[a-z0-9-_]{1,63}\\.)(xn--)?[a-z0-9-_]+(-[a-z0-9-_]+)*\\.)+(xn--)?[a-z0-9-_]{2,63})$",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"name": {
|
|
"maxLength": 100,
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"shareId": {
|
|
"anyOf": [
|
|
{
|
|
"maxLength": 50,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"teamId": {
|
|
"anyOf": [
|
|
{
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"domain"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"LoginRequest": {
|
|
"properties": {
|
|
"password": {
|
|
"description": "Umami password.",
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"description": "Umami username.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"username",
|
|
"password"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"LoginResponse": {
|
|
"anyOf": [
|
|
{
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"partialToken": {
|
|
"type": "string"
|
|
},
|
|
"requiresTwoFactor": {
|
|
"const": true,
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"requiresTwoFactor",
|
|
"partialToken"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"token": {
|
|
"type": "string"
|
|
},
|
|
"user": {
|
|
"$ref": "#/components/schemas/LoginUser"
|
|
}
|
|
},
|
|
"required": [
|
|
"token",
|
|
"user"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"LoginTeam": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"id": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
},
|
|
"logoUrl": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"logoUrl"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"LoginUser": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"createdAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
},
|
|
"isAdmin": {
|
|
"type": "boolean"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"teams": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/LoginTeam"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username",
|
|
"role",
|
|
"createdAt",
|
|
"isAdmin",
|
|
"teams"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"MetricRow": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"t": {
|
|
"type": "string"
|
|
},
|
|
"x": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
],
|
|
"description": "Dimension value (e.g. a path or country)."
|
|
},
|
|
"y": {
|
|
"description": "Count of views/events or unique visitors.",
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"x",
|
|
"y"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"MetricRows": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/MetricRow"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"OAuthAuthorizationDecision": {
|
|
"properties": {
|
|
"client_id": {
|
|
"maxLength": 2048,
|
|
"type": "string"
|
|
},
|
|
"code_challenge": {
|
|
"maxLength": 128,
|
|
"type": "string"
|
|
},
|
|
"code_challenge_method": {
|
|
"maxLength": 10,
|
|
"type": "string"
|
|
},
|
|
"decision": {
|
|
"enum": [
|
|
"approve",
|
|
"deny"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"redirect_uri": {
|
|
"maxLength": 2048,
|
|
"type": "string"
|
|
},
|
|
"resource": {
|
|
"maxLength": 2048,
|
|
"type": "string"
|
|
},
|
|
"response_type": {
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"maxLength": 500,
|
|
"type": "string"
|
|
},
|
|
"state": {
|
|
"maxLength": 1024,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"client_id",
|
|
"decision"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"OAuthAuthorizationDetails": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"client": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"logoUri": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"source": {
|
|
"enum": [
|
|
"metadata-document",
|
|
"registered"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"uri": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"source"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"redirectUri": {
|
|
"type": "string"
|
|
},
|
|
"resource": {
|
|
"type": "string"
|
|
},
|
|
"scopes": {
|
|
"items": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"scope",
|
|
"description"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"client",
|
|
"scopes",
|
|
"redirectUri",
|
|
"resource"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"OAuthAuthorizationRedirect": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"redirectUrl": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"redirectUrl"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"OAuthClientRegistrationRequest": {
|
|
"properties": {
|
|
"application_type": {
|
|
"enum": [
|
|
"web",
|
|
"native"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"client_name": {
|
|
"maxLength": 255,
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"client_uri": {
|
|
"maxLength": 2048,
|
|
"type": "string"
|
|
},
|
|
"grant_types": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"logo_uri": {
|
|
"maxLength": 2048,
|
|
"type": "string"
|
|
},
|
|
"redirect_uris": {
|
|
"items": {
|
|
"maxLength": 2048,
|
|
"type": "string"
|
|
},
|
|
"maxItems": 20,
|
|
"minItems": 1,
|
|
"type": "array"
|
|
},
|
|
"response_types": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"scope": {
|
|
"maxLength": 500,
|
|
"type": "string"
|
|
},
|
|
"software_id": {
|
|
"maxLength": 255,
|
|
"type": "string"
|
|
},
|
|
"software_version": {
|
|
"maxLength": 255,
|
|
"type": "string"
|
|
},
|
|
"token_endpoint_auth_method": {
|
|
"const": "none",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"redirect_uris",
|
|
"client_name"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"OAuthClientRegistrationResponse": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"application_type": {
|
|
"enum": [
|
|
"web",
|
|
"native"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"client_id": {
|
|
"type": "string"
|
|
},
|
|
"client_id_issued_at": {
|
|
"maximum": 9007199254740991,
|
|
"minimum": -9007199254740991,
|
|
"type": "integer"
|
|
},
|
|
"client_name": {
|
|
"maxLength": 255,
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"client_uri": {
|
|
"maxLength": 2048,
|
|
"type": "string"
|
|
},
|
|
"grant_types": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"logo_uri": {
|
|
"maxLength": 2048,
|
|
"type": "string"
|
|
},
|
|
"redirect_uris": {
|
|
"items": {
|
|
"maxLength": 2048,
|
|
"type": "string"
|
|
},
|
|
"maxItems": 20,
|
|
"minItems": 1,
|
|
"type": "array"
|
|
},
|
|
"response_types": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"scope": {
|
|
"maxLength": 500,
|
|
"type": "string"
|
|
},
|
|
"software_id": {
|
|
"maxLength": 255,
|
|
"type": "string"
|
|
},
|
|
"software_version": {
|
|
"maxLength": 255,
|
|
"type": "string"
|
|
},
|
|
"token_endpoint_auth_method": {
|
|
"const": "none",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"redirect_uris",
|
|
"client_name",
|
|
"token_endpoint_auth_method",
|
|
"grant_types",
|
|
"response_types",
|
|
"client_id",
|
|
"client_id_issued_at"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"OAuthErrorResponse": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"error": {
|
|
"type": "string"
|
|
},
|
|
"error_description": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"error"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"OAuthRevocationRequest": {
|
|
"properties": {
|
|
"token": {
|
|
"type": "string"
|
|
},
|
|
"token_type_hint": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"token"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"OAuthTokenRequest": {
|
|
"properties": {
|
|
"client_id": {
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"code_verifier": {
|
|
"type": "string"
|
|
},
|
|
"grant_type": {
|
|
"enum": [
|
|
"authorization_code",
|
|
"refresh_token"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"redirect_uri": {
|
|
"type": "string"
|
|
},
|
|
"refresh_token": {
|
|
"type": "string"
|
|
},
|
|
"resource": {
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"grant_type"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"OAuthTokenResponse": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"access_token": {
|
|
"type": "string"
|
|
},
|
|
"expires_in": {
|
|
"maximum": 9007199254740991,
|
|
"minimum": -9007199254740991,
|
|
"type": "integer"
|
|
},
|
|
"refresh_token": {
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"type": "string"
|
|
},
|
|
"token_type": {
|
|
"const": "Bearer",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"access_token",
|
|
"token_type",
|
|
"expires_in",
|
|
"refresh_token",
|
|
"scope"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"Ok": {
|
|
"additionalProperties": false,
|
|
"description": "Successful operation response.",
|
|
"properties": {
|
|
"ok": {
|
|
"const": true,
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"ReplayConfig": {
|
|
"additionalProperties": {},
|
|
"properties": {
|
|
"blockSelector": {
|
|
"type": "string"
|
|
},
|
|
"heatmapEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"heatmapSampleRate": {
|
|
"maximum": 1,
|
|
"minimum": 0,
|
|
"type": "number"
|
|
},
|
|
"maskLevel": {
|
|
"enum": [
|
|
"strict",
|
|
"moderate"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"maxDuration": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
},
|
|
"replayEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"sampleRate": {
|
|
"maximum": 1,
|
|
"minimum": 0,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"ReplayConfigInput": {
|
|
"properties": {
|
|
"blockSelector": {
|
|
"type": "string"
|
|
},
|
|
"heatmapEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"heatmapSampleRate": {
|
|
"maximum": 1,
|
|
"minimum": 0,
|
|
"type": "number"
|
|
},
|
|
"maskLevel": {
|
|
"enum": [
|
|
"strict",
|
|
"moderate"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"maxDuration": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
},
|
|
"replayEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"sampleRate": {
|
|
"maximum": 1,
|
|
"minimum": 0,
|
|
"type": "number"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"TimeSeriesPoint": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"x": {
|
|
"description": "Bucket start (ISO date/time).",
|
|
"type": "string"
|
|
},
|
|
"y": {
|
|
"description": "Value for the bucket.",
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"x",
|
|
"y"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"UpdateWebsiteRequest": {
|
|
"properties": {
|
|
"domain": {
|
|
"maxLength": 500,
|
|
"pattern": "^(localhost(:[1-9]\\d{0,4})?|((?=[a-z0-9-_]{1,63}\\.)(xn--)?[a-z0-9-_]+(-[a-z0-9-_]+)*\\.)+(xn--)?[a-z0-9-_]{2,63})$",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 100,
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"replayConfig": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReplayConfigInput"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"shareId": {
|
|
"anyOf": [
|
|
{
|
|
"maxLength": 50,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"Website": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"createdAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"createdBy": {
|
|
"anyOf": [
|
|
{
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"deletedAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"domain": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"recorderEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"replayConfig": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/ReplayConfig"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"resetAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"shareId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"teamId": {
|
|
"anyOf": [
|
|
{
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"updatedAt": {
|
|
"anyOf": [
|
|
{
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"user": {
|
|
"$ref": "#/components/schemas/WebsiteUser"
|
|
},
|
|
"userId": {
|
|
"anyOf": [
|
|
{
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name",
|
|
"domain",
|
|
"resetAt",
|
|
"userId",
|
|
"teamId",
|
|
"createdBy",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"recorderEnabled",
|
|
"replayConfig",
|
|
"shareId"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"WebsiteEvent": {
|
|
"additionalProperties": {},
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"type": "string"
|
|
},
|
|
"distinctId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"eventName": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"eventType": {
|
|
"maximum": 9007199254740991,
|
|
"minimum": -9007199254740991,
|
|
"type": "integer"
|
|
},
|
|
"hostname": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
},
|
|
"pageTitle": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"referrerDomain": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"sessionId": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
},
|
|
"urlPath": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"urlQuery": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"websiteId",
|
|
"sessionId",
|
|
"createdAt",
|
|
"eventType"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"WebsiteEventPage": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"count": {
|
|
"maximum": 9007199254740991,
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/WebsiteEvent"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"page": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
},
|
|
"pageSize": {
|
|
"maximum": 9007199254740991,
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"WebsitePage": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"count": {
|
|
"maximum": 9007199254740991,
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/Website"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
},
|
|
"pageSize": {
|
|
"maximum": 9007199254740991,
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"WebsitePageviews": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"compare": {
|
|
"additionalProperties": false,
|
|
"description": "Present when `compare` was requested.",
|
|
"properties": {
|
|
"endDate": {
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"type": "string"
|
|
},
|
|
"pageviews": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/TimeSeriesPoint"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"sessions": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/TimeSeriesPoint"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"startDate": {
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"pageviews",
|
|
"sessions",
|
|
"startDate",
|
|
"endDate"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"endDate": {
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"type": "string"
|
|
},
|
|
"pageviews": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/TimeSeriesPoint"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"sessions": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/TimeSeriesPoint"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"startDate": {
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"pageviews",
|
|
"sessions"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"WebsiteSession": {
|
|
"additionalProperties": {},
|
|
"properties": {
|
|
"browser": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"city": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"country": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"type": "string"
|
|
},
|
|
"device": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"distinctId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"events": {
|
|
"type": "number"
|
|
},
|
|
"firstAt": {
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"type": "string"
|
|
},
|
|
"hostname": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
},
|
|
"language": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"lastAt": {
|
|
"format": "date-time",
|
|
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$",
|
|
"type": "string"
|
|
},
|
|
"os": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"region": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"screen": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"views": {
|
|
"type": "number"
|
|
},
|
|
"visits": {
|
|
"type": "number"
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"websiteId",
|
|
"hostname",
|
|
"browser",
|
|
"os",
|
|
"device",
|
|
"screen",
|
|
"language",
|
|
"country",
|
|
"region",
|
|
"city",
|
|
"firstAt",
|
|
"lastAt",
|
|
"visits",
|
|
"views",
|
|
"createdAt"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"WebsiteSessionPage": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"count": {
|
|
"maximum": 9007199254740991,
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"$ref": "#/components/schemas/WebsiteSession"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"page": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
},
|
|
"pageSize": {
|
|
"maximum": 9007199254740991,
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"WebsiteStats": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"bounces": {
|
|
"type": "number"
|
|
},
|
|
"comparison": {
|
|
"$ref": "#/components/schemas/WebsiteStatsValues",
|
|
"description": "The same totals for the comparison period (previous period by default)."
|
|
},
|
|
"pageviews": {
|
|
"type": "number"
|
|
},
|
|
"totaltime": {
|
|
"type": "number"
|
|
},
|
|
"visitors": {
|
|
"type": "number"
|
|
},
|
|
"visits": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"pageviews",
|
|
"visitors",
|
|
"visits",
|
|
"bounces",
|
|
"totaltime",
|
|
"comparison"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"WebsiteStatsValues": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"bounces": {
|
|
"type": "number"
|
|
},
|
|
"pageviews": {
|
|
"type": "number"
|
|
},
|
|
"totaltime": {
|
|
"type": "number"
|
|
},
|
|
"visitors": {
|
|
"type": "number"
|
|
},
|
|
"visits": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"pageviews",
|
|
"visitors",
|
|
"visits",
|
|
"bounces",
|
|
"totaltime"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"WebsiteUser": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"id": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"securitySchemes": {
|
|
"bearerAuth": {
|
|
"bearerFormat": "JWT",
|
|
"description": "Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only).",
|
|
"scheme": "bearer",
|
|
"type": "http"
|
|
},
|
|
"oauth2": {
|
|
"description": "OAuth 2.1 access token (authorization code + PKCE). Only operations that declare an OAuth scope accept these tokens.",
|
|
"flows": {
|
|
"authorizationCode": {
|
|
"authorizationUrl": "/oauth/authorize",
|
|
"refreshUrl": "/api/oauth/token",
|
|
"scopes": {
|
|
"analytics:read": "Read analytics data (traffic, metrics, events, sessions, reports).",
|
|
"websites:read": "List and view websites you have access to."
|
|
},
|
|
"tokenUrl": "/api/oauth/token"
|
|
}
|
|
},
|
|
"type": "oauth2"
|
|
},
|
|
"shareContext": {
|
|
"description": "Required context header when authenticating with a share token.",
|
|
"in": "header",
|
|
"name": "x-umami-share-context",
|
|
"type": "apiKey"
|
|
},
|
|
"shareToken": {
|
|
"description": "Signed token returned by a share endpoint.",
|
|
"in": "header",
|
|
"name": "x-umami-share-token",
|
|
"type": "apiKey"
|
|
}
|
|
}
|
|
},
|
|
"externalDocs": {
|
|
"description": "Umami API documentation",
|
|
"url": "https://docs.umami.is/docs/api"
|
|
},
|
|
"info": {
|
|
"description": "REST API for Umami analytics. Every App Router API operation is included. Operations marked with x-umami-contract: inferred are generated from handler source; colocated explicit contracts provide curated descriptions and exact response models. Self-hosted deployments serve these paths beneath their configured BASE_PATH.",
|
|
"license": {
|
|
"identifier": "MIT",
|
|
"name": "MIT"
|
|
},
|
|
"title": "Umami API",
|
|
"version": "3.3.0"
|
|
},
|
|
"openapi": "3.1.0",
|
|
"paths": {
|
|
"/api/2fa/disable": {
|
|
"post": {
|
|
"operationId": "disableTwoFactor",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"password": {
|
|
"type": "string"
|
|
},
|
|
"token": {
|
|
"maxLength": 6,
|
|
"minLength": 6,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"password",
|
|
"token"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"properties": {
|
|
"error": {
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"lockedUntil": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"code",
|
|
"message",
|
|
"lockedUntil"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"error"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"ok": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"403": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "forbidden",
|
|
"message": "Forbidden.",
|
|
"status": 403
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Forbidden."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
},
|
|
"429": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"error": {
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"lockedUntil": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"code",
|
|
"message",
|
|
"lockedUntil"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"error"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service-unavailable",
|
|
"message": "Service unavailable.",
|
|
"status": 503
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Service unavailable."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update 2fa disable",
|
|
"tags": [
|
|
"Two-factor authentication"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/2fa/disable/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/2fa/setup/cancel": {
|
|
"post": {
|
|
"operationId": "cancelTwoFactorSetup",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update 2fa setup cancel",
|
|
"tags": [
|
|
"Two-factor authentication"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/2fa/setup/cancel/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/2fa/setup/confirm": {
|
|
"post": {
|
|
"operationId": "confirmTwoFactorSetup",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"token": {
|
|
"maxLength": 6,
|
|
"minLength": 6,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"token"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"properties": {
|
|
"error": {
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"lockedUntil": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"code",
|
|
"message",
|
|
"lockedUntil"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"error"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"backupCodes": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"backupCodes"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
},
|
|
"429": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"error": {
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"lockedUntil": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"code",
|
|
"message",
|
|
"lockedUntil"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"error"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service-unavailable",
|
|
"message": "Service unavailable.",
|
|
"status": 503
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Service unavailable."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update 2fa setup confirm",
|
|
"tags": [
|
|
"Two-factor authentication"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/2fa/setup/confirm/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/2fa/setup/initiate": {
|
|
"post": {
|
|
"operationId": "initiateTwoFactorSetup",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"manualKey": {
|
|
"type": "string"
|
|
},
|
|
"qrCodeDataUrl": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"qrCodeDataUrl",
|
|
"manualKey"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service-unavailable",
|
|
"message": "Service unavailable.",
|
|
"status": 503
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Service unavailable."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update 2fa setup initiate",
|
|
"tags": [
|
|
"Two-factor authentication"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/2fa/setup/initiate/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/2fa/status": {
|
|
"get": {
|
|
"operationId": "getTwoFactorStatus",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"properties": {
|
|
"globalRequired": {
|
|
"type": "boolean"
|
|
},
|
|
"isConfigured": {
|
|
"type": "boolean"
|
|
},
|
|
"isEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"isRequired": {
|
|
"type": "boolean"
|
|
},
|
|
"requiredReason": {
|
|
"type": "null"
|
|
}
|
|
},
|
|
"required": [
|
|
"isEnabled",
|
|
"isRequired",
|
|
"requiredReason",
|
|
"isConfigured",
|
|
"globalRequired"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"globalRequired": {
|
|
"type": "boolean"
|
|
},
|
|
"isConfigured": {
|
|
"type": "boolean"
|
|
},
|
|
"isEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"isRequired": {
|
|
"type": "boolean"
|
|
},
|
|
"requiredReason": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"isEnabled",
|
|
"isRequired",
|
|
"requiredReason",
|
|
"isConfigured",
|
|
"globalRequired"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Get 2fa status",
|
|
"tags": [
|
|
"Two-factor authentication"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/2fa/status/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/2fa/verify": {
|
|
"post": {
|
|
"operationId": "verifyTwoFactor",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"properties": {
|
|
"token": {
|
|
"maxLength": 6,
|
|
"minLength": 6,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"token"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"backupCode": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"backupCode"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"properties": {
|
|
"error": {
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"lockedUntil": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"code",
|
|
"message",
|
|
"lockedUntil"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"error"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"token": {
|
|
"type": "string"
|
|
},
|
|
"user": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"isAdmin": {
|
|
"type": "boolean"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"teams": {
|
|
"items": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"logoUrl",
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username",
|
|
"role",
|
|
"createdAt",
|
|
"isAdmin",
|
|
"teams"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"token",
|
|
"user"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
},
|
|
"429": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"error": {
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"lockedUntil": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"code",
|
|
"message",
|
|
"lockedUntil"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"error"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service-unavailable",
|
|
"message": "Service unavailable.",
|
|
"status": 503
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Service unavailable."
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Create or update 2fa verify",
|
|
"tags": [
|
|
"Two-factor authentication"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/2fa/verify/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/admin/2fa/global": {
|
|
"post": {
|
|
"operationId": "postAdmin2faGlobal",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"required": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"required"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"type": "boolean"
|
|
},
|
|
"required": {}
|
|
},
|
|
"required": [
|
|
"ok",
|
|
"required"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service-unavailable",
|
|
"message": "Service unavailable.",
|
|
"status": 503
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Service unavailable."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update admin 2fa global",
|
|
"tags": [
|
|
"Administration"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/admin/2fa/global/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/admin/teams": {
|
|
"get": {
|
|
"operationId": "getAdminTeams",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"accessCode": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"twoFactorRequired": {
|
|
"type": "boolean"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"logoUrl",
|
|
"twoFactorRequired",
|
|
"deletedAt",
|
|
"name",
|
|
"accessCode"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get admin teams",
|
|
"tags": [
|
|
"Administration"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/admin/teams/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/admin/teams/{teamId}/2fa": {
|
|
"post": {
|
|
"operationId": "postAdminTeamsTeamId2fa",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "teamId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"required": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"required"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"type": "boolean"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"twoFactorRequired": {}
|
|
},
|
|
"required": [
|
|
"ok",
|
|
"teamId",
|
|
"twoFactorRequired"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service-unavailable",
|
|
"message": "Service unavailable.",
|
|
"status": 503
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Service unavailable."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update admin teams team id 2fa",
|
|
"tags": [
|
|
"Administration"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/admin/teams/[teamId]/2fa/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/admin/users": {
|
|
"get": {
|
|
"operationId": "getAdminUsers",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"_count": {
|
|
"properties": {
|
|
"websites": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"websites"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"twoFactorRequired": {
|
|
"type": "boolean"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username",
|
|
"role",
|
|
"createdAt",
|
|
"twoFactorRequired"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get admin users",
|
|
"tags": [
|
|
"Administration"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/admin/users/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/admin/users/{userId}/2fa": {
|
|
"delete": {
|
|
"operationId": "deleteAdminUsersUserId2fa",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "userId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"type": "boolean"
|
|
},
|
|
"reset": {
|
|
"properties": {
|
|
"backupCodes": {},
|
|
"otpUsed": {},
|
|
"rateLimit": {},
|
|
"twoFactorAuth": {}
|
|
},
|
|
"required": [
|
|
"twoFactorAuth",
|
|
"backupCodes",
|
|
"otpUsed",
|
|
"rateLimit"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"ok",
|
|
"userId",
|
|
"reset"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Delete admin users user id 2fa",
|
|
"tags": [
|
|
"Administration"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/admin/users/[userId]/2fa/contract.generated.ts"
|
|
},
|
|
"get": {
|
|
"operationId": "getAdminUsersUserId2fa",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "userId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"isEnabled": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"isEnabled"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Get admin users user id 2fa",
|
|
"tags": [
|
|
"Administration"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/admin/users/[userId]/2fa/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "postAdminUsersUserId2fa",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "userId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"required": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"required"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"type": "boolean"
|
|
},
|
|
"twoFactorRequired": {},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"ok",
|
|
"userId",
|
|
"twoFactorRequired"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service-unavailable",
|
|
"message": "Service unavailable.",
|
|
"status": 503
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Service unavailable."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update admin users user id 2fa",
|
|
"tags": [
|
|
"Administration"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/admin/users/[userId]/2fa/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/admin/websites": {
|
|
"get": {
|
|
"operationId": "getAdminWebsites",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"allOf": [
|
|
{
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"createdBy": {
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"domain": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"recorderEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"replayConfig": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"resetAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"createdBy",
|
|
"name",
|
|
"domain",
|
|
"resetAt",
|
|
"teamId",
|
|
"recorderEnabled",
|
|
"replayConfig"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"createUser": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"shareId": {
|
|
"type": "string"
|
|
},
|
|
"team": {
|
|
"properties": {
|
|
"members": {
|
|
"items": {
|
|
"properties": {
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"userId",
|
|
"role"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"members"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"user": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"shareId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get admin websites",
|
|
"tags": [
|
|
"Administration"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/admin/websites/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/auth/login": {
|
|
"post": {
|
|
"description": "Authenticates a self-hosted Umami user. Users with two-factor authentication receive a short-lived partial token instead of a full bearer token.",
|
|
"operationId": "login",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/LoginRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/LoginResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "Authenticated successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"503": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "service-unavailable",
|
|
"message": "Service unavailable.",
|
|
"status": 503
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Service unavailable."
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Log in",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/auth/login/contract.ts"
|
|
}
|
|
},
|
|
"/api/auth/logout": {
|
|
"post": {
|
|
"operationId": "logout",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"const": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update auth logout",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/auth/logout/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/auth/sso": {
|
|
"post": {
|
|
"operationId": "sso",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"token": {
|
|
"type": "string"
|
|
},
|
|
"user": {}
|
|
},
|
|
"required": [
|
|
"user",
|
|
"token"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "server-error",
|
|
"message": "Server error.",
|
|
"status": 500
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Server error."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update auth sso",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/auth/sso/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/auth/subscription": {
|
|
"get": {
|
|
"operationId": "getSubscription",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "teamId",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"properties": {
|
|
"error": {
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"message",
|
|
"code",
|
|
"status"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"error"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"hasSubscription": {
|
|
"type": "boolean"
|
|
},
|
|
"isBusiness": {
|
|
"type": "boolean"
|
|
},
|
|
"isNoBilling": {
|
|
"type": "boolean"
|
|
},
|
|
"isPro": {
|
|
"type": "boolean"
|
|
},
|
|
"unlimitedWebsites": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"isPro",
|
|
"isBusiness",
|
|
"isNoBilling",
|
|
"hasSubscription",
|
|
"unlimitedWebsites"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get auth subscription",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/auth/subscription/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/auth/verify": {
|
|
"post": {
|
|
"operationId": "verify",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"teams": {}
|
|
},
|
|
"required": [
|
|
"teams"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update auth verify",
|
|
"tags": [
|
|
"Authentication"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/auth/verify/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/batch": {
|
|
"post": {
|
|
"operationId": "batch",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"maxItems": 500,
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"cache": {},
|
|
"details": {
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
"errors": {
|
|
"type": "number"
|
|
},
|
|
"processed": {
|
|
"type": "number"
|
|
},
|
|
"size": {}
|
|
},
|
|
"required": [
|
|
"size",
|
|
"processed",
|
|
"errors",
|
|
"details",
|
|
"cache"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "server-error",
|
|
"message": "Server error.",
|
|
"status": 500
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Server error."
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Create or update batch",
|
|
"tags": [
|
|
"Collection"
|
|
],
|
|
"x-umami-audience": "collect",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/batch/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/boards": {
|
|
"get": {
|
|
"operationId": "getBoards",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"teamId",
|
|
"type",
|
|
"description",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Get boards",
|
|
"tags": [
|
|
"Boards"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/boards/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "createBoard",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"maxLength": 500,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 100,
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"properties": {
|
|
"linkId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
},
|
|
"pixelId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"teamId": {
|
|
"anyOf": [
|
|
{
|
|
"format": "uuid",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"enum": [],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"const": "open"
|
|
}
|
|
]
|
|
},
|
|
"userId": {
|
|
"anyOf": [
|
|
{
|
|
"format": "uuid",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"teamId",
|
|
"type",
|
|
"description",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Create or update boards",
|
|
"tags": [
|
|
"Boards"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/boards/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/boards/{boardId}": {
|
|
"delete": {
|
|
"operationId": "deleteBoard",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "boardId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"const": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Delete boards board id",
|
|
"tags": [
|
|
"Boards"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/boards/[boardId]/contract.generated.ts"
|
|
},
|
|
"get": {
|
|
"operationId": "getBoard",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "boardId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"teamId",
|
|
"type",
|
|
"description",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get boards board id",
|
|
"tags": [
|
|
"Boards"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/boards/[boardId]/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "updateBoard",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "boardId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"maxLength": 500,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 200,
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"enum": [],
|
|
"type": "string"
|
|
},
|
|
{
|
|
"const": "open"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"teamId",
|
|
"type",
|
|
"description",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "server-error",
|
|
"message": "Server error.",
|
|
"status": 500
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Server error."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Create or update boards board id",
|
|
"tags": [
|
|
"Boards"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/boards/[boardId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/boards/{boardId}/clone": {
|
|
"post": {
|
|
"operationId": "cloneBoard",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "boardId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"maxLength": 500,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 200,
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"properties": {},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"teamId",
|
|
"type",
|
|
"description",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Create or update boards board id clone",
|
|
"tags": [
|
|
"Boards"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/boards/[boardId]/clone/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/boards/{boardId}/shares": {
|
|
"get": {
|
|
"operationId": "getBoardShares",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "boardId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"entityId": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"shareType": {
|
|
"type": "number"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"slug",
|
|
"parameters",
|
|
"entityId",
|
|
"shareType"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get boards board id shares",
|
|
"tags": [
|
|
"Boards"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/boards/[boardId]/shares/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "createBoardShare",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "boardId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"maxLength": 200,
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"entityId": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"shareType": {
|
|
"type": "number"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"slug",
|
|
"parameters",
|
|
"entityId",
|
|
"shareType"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update boards board id shares",
|
|
"tags": [
|
|
"Boards"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/boards/[boardId]/shares/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/config": {
|
|
"get": {
|
|
"operationId": "getConfig",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"cloudMode": {
|
|
"type": "boolean"
|
|
},
|
|
"faviconUrl": {
|
|
"type": "string"
|
|
},
|
|
"linksUrl": {
|
|
"type": "string"
|
|
},
|
|
"pixelsUrl": {
|
|
"type": "string"
|
|
},
|
|
"privateMode": {
|
|
"type": "boolean"
|
|
},
|
|
"sessionDeletionEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"telemetryDisabled": {
|
|
"type": "boolean"
|
|
},
|
|
"trackerScriptName": {
|
|
"type": "string"
|
|
},
|
|
"updatesDisabled": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"cloudMode",
|
|
"faviconUrl",
|
|
"linksUrl",
|
|
"pixelsUrl",
|
|
"privateMode",
|
|
"sessionDeletionEnabled",
|
|
"telemetryDisabled",
|
|
"trackerScriptName",
|
|
"updatesDisabled"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Get config",
|
|
"tags": [
|
|
"Configuration"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/config/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/dashboard": {
|
|
"get": {
|
|
"operationId": "getDashboard",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"teamId",
|
|
"type",
|
|
"description",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Get dashboard",
|
|
"tags": [
|
|
"Dashboard"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/dashboard/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "postDashboard",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"maxLength": 500,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 200,
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"properties": {},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"teamId",
|
|
"type",
|
|
"description",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update dashboard",
|
|
"tags": [
|
|
"Dashboard"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/dashboard/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/heartbeat": {
|
|
"get": {
|
|
"operationId": "getHeartbeat",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Get heartbeat",
|
|
"tags": [
|
|
"System"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/heartbeat/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/links": {
|
|
"get": {
|
|
"operationId": "getLinks",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"name",
|
|
"teamId",
|
|
"url",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Get links",
|
|
"tags": [
|
|
"Links"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/links/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "createLink",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"format": "uuid",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"name": {
|
|
"maxLength": 100,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"maxLength": 100,
|
|
"minLength": 8,
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"url": {
|
|
"maxLength": 500,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"url",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"name",
|
|
"teamId",
|
|
"url",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update links",
|
|
"tags": [
|
|
"Links"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/links/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/links/{linkId}": {
|
|
"delete": {
|
|
"operationId": "deleteLink",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "linkId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"const": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Delete links link id",
|
|
"tags": [
|
|
"Links"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/links/[linkId]/contract.generated.ts"
|
|
},
|
|
"get": {
|
|
"operationId": "getLink",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "linkId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"name",
|
|
"teamId",
|
|
"url",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get links link id",
|
|
"tags": [
|
|
"Links"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/links/[linkId]/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "updateLink",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "linkId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"maxLength": 100,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"maxLength": 100,
|
|
"minLength": 8,
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"maxLength": 500,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"name",
|
|
"teamId",
|
|
"url",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "server-error",
|
|
"message": "Server error.",
|
|
"status": 500
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Server error."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update links link id",
|
|
"tags": [
|
|
"Links"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/links/[linkId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/links/{linkId}/shares": {
|
|
"get": {
|
|
"operationId": "getLinkShares",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "linkId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"entityId": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"shareType": {
|
|
"type": "number"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"slug",
|
|
"parameters",
|
|
"entityId",
|
|
"shareType"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get links link id shares",
|
|
"tags": [
|
|
"Links"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/links/[linkId]/shares/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "createLinkShare",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "linkId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"maxLength": 200,
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"entityId": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"shareType": {
|
|
"type": "number"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"slug",
|
|
"parameters",
|
|
"entityId",
|
|
"shareType"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update links link id shares",
|
|
"tags": [
|
|
"Links"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/links/[linkId]/shares/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/links/charts": {
|
|
"get": {
|
|
"operationId": "getLinksCharts",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "ids",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"additionalProperties": {
|
|
"properties": {
|
|
"total": {
|
|
"type": "number"
|
|
},
|
|
"values": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"values",
|
|
"total"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get links charts",
|
|
"tags": [
|
|
"Links"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/links/charts/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/me": {
|
|
"get": {
|
|
"operationId": "getMe",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"apiKey": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"authType": {
|
|
"anyOf": [
|
|
{
|
|
"const": "session"
|
|
},
|
|
{
|
|
"const": "share"
|
|
},
|
|
{
|
|
"const": "api-key"
|
|
},
|
|
{
|
|
"const": "oauth"
|
|
}
|
|
]
|
|
},
|
|
"oauth": {
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "string"
|
|
},
|
|
"scopes": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"tokenId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"clientId",
|
|
"scopes"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"shareToken": {
|
|
"properties": {
|
|
"boardId": {
|
|
"type": "string"
|
|
},
|
|
"linkId": {
|
|
"type": "string"
|
|
},
|
|
"linkIds": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"const": "light"
|
|
},
|
|
{
|
|
"const": "dark"
|
|
}
|
|
]
|
|
},
|
|
"properties": {
|
|
"allowFilter": {
|
|
"type": "boolean"
|
|
},
|
|
"theme": {
|
|
"anyOf": [
|
|
{
|
|
"const": "light"
|
|
},
|
|
{
|
|
"const": "dark"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"pixelId": {
|
|
"type": "string"
|
|
},
|
|
"pixelIds": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"shareType": {
|
|
"type": "number"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
},
|
|
"websiteIds": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"user": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"isAdmin": {
|
|
"type": "boolean"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username",
|
|
"role",
|
|
"isAdmin"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"websites:read"
|
|
]
|
|
}
|
|
],
|
|
"summary": "Get me",
|
|
"tags": [
|
|
"Account"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "websites:read",
|
|
"x-umami-source": "src/app/api/me/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/me/api-keys": {
|
|
"get": {
|
|
"operationId": "getMyApiKeys",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"keyPrefix": {
|
|
"type": "string"
|
|
},
|
|
"lastUsedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"name",
|
|
"keyPrefix",
|
|
"lastUsedAt"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Get me api keys",
|
|
"tags": [
|
|
"Account"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/me/api-keys/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "createMyApiKey",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"maximum": 255,
|
|
"minimum": 1
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"type": "string"
|
|
},
|
|
"keyPrefix": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"key",
|
|
"id",
|
|
"createdAt",
|
|
"name",
|
|
"keyPrefix"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update me api keys",
|
|
"tags": [
|
|
"Account"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/me/api-keys/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/me/api-keys/{keyId}": {
|
|
"delete": {
|
|
"operationId": "deleteMyApiKey",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "keyId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"const": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Delete me api keys key id",
|
|
"tags": [
|
|
"Account"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/me/api-keys/[keyId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/me/password": {
|
|
"post": {
|
|
"operationId": "updateMyPassword",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"currentPassword": {
|
|
"type": "string"
|
|
},
|
|
"newPassword": {
|
|
"minLength": 8,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"currentPassword",
|
|
"newPassword"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"username",
|
|
"role"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update me password",
|
|
"tags": [
|
|
"Account"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/me/password/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/me/teams": {
|
|
"get": {
|
|
"operationId": "getMyTeams",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"accessCode": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"twoFactorRequired": {
|
|
"type": "boolean"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"logoUrl",
|
|
"twoFactorRequired",
|
|
"deletedAt",
|
|
"name",
|
|
"accessCode"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Get me teams",
|
|
"tags": [
|
|
"Account"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/me/teams/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/me/websites": {
|
|
"get": {
|
|
"operationId": "getMyWebsites",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "includeTeams",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"allOf": [
|
|
{
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"createdBy": {
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"domain": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"recorderEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"replayConfig": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"resetAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"createdBy",
|
|
"name",
|
|
"domain",
|
|
"resetAt",
|
|
"teamId",
|
|
"recorderEnabled",
|
|
"replayConfig"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"createUser": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"shareId": {
|
|
"type": "string"
|
|
},
|
|
"team": {
|
|
"properties": {
|
|
"members": {
|
|
"items": {
|
|
"properties": {
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"userId",
|
|
"role"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"members"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"user": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"shareId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Get me websites",
|
|
"tags": [
|
|
"Account"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/me/websites/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/oauth/authorize": {
|
|
"get": {
|
|
"description": "Validates an OAuth 2.1 authorization request and returns the client and scopes for the consent screen. Requires an interactive user session.",
|
|
"operationId": "describeOAuthAuthorization",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "response_type",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "client_id",
|
|
"required": true,
|
|
"schema": {
|
|
"maxLength": 2048,
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "redirect_uri",
|
|
"schema": {
|
|
"maxLength": 2048,
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "scope",
|
|
"schema": {
|
|
"maxLength": 500,
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "state",
|
|
"schema": {
|
|
"maxLength": 1024,
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "code_challenge",
|
|
"schema": {
|
|
"maxLength": 128,
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "code_challenge_method",
|
|
"schema": {
|
|
"maxLength": 10,
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "resource",
|
|
"schema": {
|
|
"maxLength": 2048,
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthAuthorizationDetails"
|
|
}
|
|
}
|
|
},
|
|
"description": "Authorization request details."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "Invalid authorization request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Describe a pending OAuth authorization request",
|
|
"tags": [
|
|
"OAuth"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/oauth/authorize/contract.ts"
|
|
},
|
|
"post": {
|
|
"description": "Records the user decision. On approval an authorization code is issued and the redirect URL (with code, state and iss) is returned.",
|
|
"operationId": "decideOAuthAuthorization",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthAuthorizationDecision"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthAuthorizationRedirect"
|
|
}
|
|
}
|
|
},
|
|
"description": "Redirect URL for the browser."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Approve or deny an OAuth authorization request",
|
|
"tags": [
|
|
"OAuth"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/oauth/authorize/contract.ts"
|
|
}
|
|
},
|
|
"/api/oauth/register": {
|
|
"post": {
|
|
"description": "RFC 7591 compatibility endpoint for MCP clients without Client ID Metadata Document support. Registers a public client. Prefer Client ID Metadata Documents (https URL client_id).",
|
|
"operationId": "oauthRegisterClient",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthClientRegistrationRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthClientRegistrationResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "Registered client."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "Invalid client metadata."
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Register an OAuth client (dynamic client registration)",
|
|
"tags": [
|
|
"OAuth"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/oauth/register/contract.ts"
|
|
}
|
|
},
|
|
"/api/oauth/revoke": {
|
|
"post": {
|
|
"description": "RFC 7009 revocation endpoint. Revokes the given refresh token; unknown tokens are accepted silently.",
|
|
"operationId": "oauthRevoke",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthRevocationRequest"
|
|
}
|
|
},
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthRevocationRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": false,
|
|
"properties": {},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "Token revoked (or already invalid)."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "Malformed request."
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Revoke an OAuth refresh token",
|
|
"tags": [
|
|
"OAuth"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/oauth/revoke/contract.ts"
|
|
}
|
|
},
|
|
"/api/oauth/token": {
|
|
"post": {
|
|
"description": "Exchanges an authorization code (with PKCE code_verifier) or a refresh token for an access token. Accepts application/x-www-form-urlencoded or JSON. Refresh tokens are rotated on every use.",
|
|
"operationId": "oauthToken",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthTokenRequest"
|
|
}
|
|
},
|
|
"application/x-www-form-urlencoded": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthTokenRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthTokenResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "Access and refresh tokens."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "Invalid grant or request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/OAuthErrorResponse"
|
|
}
|
|
}
|
|
},
|
|
"description": "Invalid client."
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "OAuth 2.1 token endpoint",
|
|
"tags": [
|
|
"OAuth"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/oauth/token/contract.ts"
|
|
}
|
|
},
|
|
"/api/pixels": {
|
|
"get": {
|
|
"operationId": "getPixels",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"name",
|
|
"teamId",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Get pixels",
|
|
"tags": [
|
|
"Pixels"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/pixels/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "createPixel",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"id": {
|
|
"anyOf": [
|
|
{
|
|
"format": "uuid",
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
},
|
|
"name": {
|
|
"maxLength": 100,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"maxLength": 100,
|
|
"minLength": 8,
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"name",
|
|
"teamId",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update pixels",
|
|
"tags": [
|
|
"Pixels"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/pixels/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/pixels/{pixelId}": {
|
|
"delete": {
|
|
"operationId": "deletePixel",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "pixelId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"const": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Delete pixels pixel id",
|
|
"tags": [
|
|
"Pixels"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/pixels/[pixelId]/contract.generated.ts"
|
|
},
|
|
"get": {
|
|
"operationId": "getPixel",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "pixelId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"name",
|
|
"teamId",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get pixels pixel id",
|
|
"tags": [
|
|
"Pixels"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/pixels/[pixelId]/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "updatePixel",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "pixelId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"maxLength": 100,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"maxLength": 100,
|
|
"minLength": 8,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"name",
|
|
"teamId",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "server-error",
|
|
"message": "Server error.",
|
|
"status": 500
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Server error."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update pixels pixel id",
|
|
"tags": [
|
|
"Pixels"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/pixels/[pixelId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/pixels/{pixelId}/shares": {
|
|
"get": {
|
|
"operationId": "getPixelShares",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "pixelId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"entityId": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"shareType": {
|
|
"type": "number"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"slug",
|
|
"parameters",
|
|
"entityId",
|
|
"shareType"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get pixels pixel id shares",
|
|
"tags": [
|
|
"Pixels"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/pixels/[pixelId]/shares/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "createPixelShare",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "pixelId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"maxLength": 200,
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"entityId": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"shareType": {
|
|
"type": "number"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"slug",
|
|
"parameters",
|
|
"entityId",
|
|
"shareType"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update pixels pixel id shares",
|
|
"tags": [
|
|
"Pixels"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/pixels/[pixelId]/shares/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/pixels/charts": {
|
|
"get": {
|
|
"operationId": "getPixelsCharts",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "ids",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"additionalProperties": {
|
|
"properties": {
|
|
"total": {
|
|
"type": "number"
|
|
},
|
|
"values": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"values",
|
|
"total"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get pixels charts",
|
|
"tags": [
|
|
"Pixels"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/pixels/charts/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/realtime/{websiteId}": {
|
|
"get": {
|
|
"operationId": "getRealtime",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"countries": {
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
"events": {
|
|
"items": {
|
|
"properties": {
|
|
"__type": {
|
|
"anyOf": [
|
|
{
|
|
"const": "event"
|
|
},
|
|
{
|
|
"const": "session"
|
|
},
|
|
{
|
|
"const": "pageview"
|
|
}
|
|
]
|
|
},
|
|
"browser": {
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"device": {
|
|
"type": "string"
|
|
},
|
|
"eventName": {
|
|
"type": "string"
|
|
},
|
|
"hostname": {
|
|
"type": "string"
|
|
},
|
|
"os": {
|
|
"type": "string"
|
|
},
|
|
"referrerDomain": {
|
|
"type": "string"
|
|
},
|
|
"sessionId": {
|
|
"type": "string"
|
|
},
|
|
"urlPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"__type",
|
|
"sessionId",
|
|
"eventName",
|
|
"createdAt",
|
|
"browser",
|
|
"os",
|
|
"device",
|
|
"country",
|
|
"urlPath",
|
|
"referrerDomain",
|
|
"hostname"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"referrers": {
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
"series": {
|
|
"properties": {
|
|
"views": {
|
|
"items": {
|
|
"properties": {
|
|
"t": {
|
|
"type": "string"
|
|
},
|
|
"x": {
|
|
"type": "string"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"x",
|
|
"t",
|
|
"y"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"visitors": {
|
|
"items": {
|
|
"properties": {
|
|
"t": {
|
|
"type": "string"
|
|
},
|
|
"x": {
|
|
"type": "string"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"x",
|
|
"t",
|
|
"y"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"views",
|
|
"visitors"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"timestamp": {
|
|
"type": "number"
|
|
},
|
|
"totals": {
|
|
"properties": {
|
|
"countries": {
|
|
"type": "number"
|
|
},
|
|
"events": {
|
|
"type": "number"
|
|
},
|
|
"views": {
|
|
"type": "number"
|
|
},
|
|
"visitors": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"views",
|
|
"visitors",
|
|
"events",
|
|
"countries"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"urls": {
|
|
"additionalProperties": {
|
|
"type": "number"
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"countries",
|
|
"events",
|
|
"referrers",
|
|
"timestamp",
|
|
"series",
|
|
"totals",
|
|
"urls"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get realtime website id",
|
|
"tags": [
|
|
"Realtime"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/realtime/[websiteId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/record": {
|
|
"post": {
|
|
"operationId": "record",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"properties": {
|
|
"payload": {
|
|
"properties": {
|
|
"events": {
|
|
"items": {},
|
|
"maxItems": 200,
|
|
"type": "array"
|
|
},
|
|
"timestamp": {
|
|
"type": "integer"
|
|
},
|
|
"website": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"website",
|
|
"events"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"const": "record"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"payload"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"payload": {
|
|
"properties": {
|
|
"events": {
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"properties": {
|
|
"pageH": {
|
|
"type": "number"
|
|
},
|
|
"pageW": {
|
|
"type": "number"
|
|
},
|
|
"pageX": {
|
|
"type": "number"
|
|
},
|
|
"pageY": {
|
|
"type": "number"
|
|
},
|
|
"timestamp": {
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "click"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"viewportH": {
|
|
"type": "number"
|
|
},
|
|
"viewportW": {
|
|
"type": "number"
|
|
},
|
|
"x": {
|
|
"type": "number"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"url"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"pageH": {
|
|
"type": "number"
|
|
},
|
|
"pageW": {
|
|
"type": "number"
|
|
},
|
|
"scrollPct": {
|
|
"type": "number"
|
|
},
|
|
"timestamp": {
|
|
"type": "integer"
|
|
},
|
|
"type": {
|
|
"const": "scroll"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"viewportH": {
|
|
"type": "number"
|
|
},
|
|
"viewportW": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"url"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"maxItems": 200,
|
|
"type": "array"
|
|
},
|
|
"timestamp": {
|
|
"type": "integer"
|
|
},
|
|
"website": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"website",
|
|
"events"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"const": "heatmap"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"payload"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"properties": {
|
|
"ok": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"ok": {
|
|
"type": "boolean"
|
|
},
|
|
"reason": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"ok",
|
|
"reason"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"beep": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"beep"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"403": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "forbidden",
|
|
"message": "Forbidden.",
|
|
"status": 403
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Forbidden."
|
|
},
|
|
"413": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "payload-too-large",
|
|
"message": "Payload too large.",
|
|
"status": 413
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Payload too large."
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "server-error",
|
|
"message": "Server error.",
|
|
"status": 500
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Server error."
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Create or update record",
|
|
"tags": [
|
|
"Collection"
|
|
],
|
|
"x-umami-audience": "collect",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/record/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/reports": {
|
|
"get": {
|
|
"operationId": "getReports",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"allOf": [
|
|
{
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"type",
|
|
"description",
|
|
"parameters",
|
|
"websiteId"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"website": {
|
|
"properties": {
|
|
"domain": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"domain",
|
|
"userId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get reports",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/reports/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "createReport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"maxLength": 500,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 200,
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"websiteId",
|
|
"type",
|
|
"name",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"type",
|
|
"description",
|
|
"parameters",
|
|
"websiteId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update reports",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/reports/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/reports/{reportId}": {
|
|
"delete": {
|
|
"operationId": "deleteReport",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "reportId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"const": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Delete reports report id",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/reports/[reportId]/contract.generated.ts"
|
|
},
|
|
"get": {
|
|
"operationId": "getReport",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "reportId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"type",
|
|
"description",
|
|
"parameters",
|
|
"websiteId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get reports report id",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/reports/[reportId]/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "updateReport",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "reportId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"description": {
|
|
"maxLength": 500,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 200,
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"websiteId",
|
|
"type",
|
|
"name",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"type",
|
|
"description",
|
|
"parameters",
|
|
"websiteId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update reports report id",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/reports/[reportId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/reports/attribution": {
|
|
"post": {
|
|
"operationId": "runAttributionReport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"filters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"websiteId",
|
|
"filters",
|
|
"type",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"paidAds": {
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"value"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"referrer": {
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"value"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"total": {
|
|
"properties": {
|
|
"pageviews": {
|
|
"type": "number"
|
|
},
|
|
"visitors": {
|
|
"type": "number"
|
|
},
|
|
"visits": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"pageviews",
|
|
"visitors",
|
|
"visits"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"utm_campaign": {
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"value"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"utm_content": {
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"value"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"utm_medium": {
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"value"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"utm_source": {
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"value"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"utm_term": {
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"value"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"referrer",
|
|
"paidAds",
|
|
"utm_source",
|
|
"utm_medium",
|
|
"utm_campaign",
|
|
"utm_content",
|
|
"utm_term",
|
|
"total"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Create or update reports attribution",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/reports/attribution/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/reports/breakdown": {
|
|
"post": {
|
|
"operationId": "runBreakdownReport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"filters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"websiteId",
|
|
"filters",
|
|
"type",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
}
|
|
]
|
|
},
|
|
"properties": {
|
|
"bounces": {
|
|
"type": "number"
|
|
},
|
|
"totaltime": {
|
|
"type": "number"
|
|
},
|
|
"views": {
|
|
"type": "number"
|
|
},
|
|
"visitors": {
|
|
"type": "number"
|
|
},
|
|
"visits": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"views",
|
|
"visitors",
|
|
"visits",
|
|
"bounces",
|
|
"totaltime"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Create or update reports breakdown",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/reports/breakdown/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/reports/funnel": {
|
|
"post": {
|
|
"operationId": "runFunnelReport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"filters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"websiteId",
|
|
"filters",
|
|
"type",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"dropoff": {
|
|
"type": "number"
|
|
},
|
|
"dropped": {
|
|
"type": "number"
|
|
},
|
|
"filters": {
|
|
"items": {
|
|
"properties": {
|
|
"operator": {
|
|
"type": "string"
|
|
},
|
|
"property": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"property",
|
|
"operator",
|
|
"value"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"previous": {
|
|
"type": "number"
|
|
},
|
|
"remaining": {
|
|
"type": "number"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
},
|
|
"visitors": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"visitors",
|
|
"previous",
|
|
"dropped",
|
|
"dropoff",
|
|
"remaining",
|
|
"type",
|
|
"value"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Create or update reports funnel",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/reports/funnel/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/reports/goal": {
|
|
"post": {
|
|
"operationId": "runGoalReport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"filters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"websiteId",
|
|
"filters",
|
|
"type",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"num": {
|
|
"type": "number"
|
|
},
|
|
"total": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"num",
|
|
"total"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Create or update reports goal",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/reports/goal/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/reports/heatmap": {
|
|
"post": {
|
|
"operationId": "runHeatmapReport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"filters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"websiteId",
|
|
"filters",
|
|
"type",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"mode": {
|
|
"anyOf": [
|
|
{
|
|
"const": "click"
|
|
},
|
|
{
|
|
"const": "scroll"
|
|
}
|
|
]
|
|
},
|
|
"pages": {
|
|
"items": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"sessions": {
|
|
"type": "number"
|
|
},
|
|
"urlPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"urlPath",
|
|
"count",
|
|
"sessions"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"points": {
|
|
"items": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"pageH": {
|
|
"type": "number"
|
|
},
|
|
"pageW": {
|
|
"type": "number"
|
|
},
|
|
"pageX": {
|
|
"type": "number"
|
|
},
|
|
"pageY": {
|
|
"type": "number"
|
|
},
|
|
"viewportH": {
|
|
"type": "number"
|
|
},
|
|
"viewportW": {
|
|
"type": "number"
|
|
},
|
|
"x": {
|
|
"type": "number"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"x",
|
|
"y",
|
|
"pageX",
|
|
"pageY",
|
|
"pageW",
|
|
"pageH",
|
|
"viewportW",
|
|
"viewportH",
|
|
"count"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"scroll": {
|
|
"properties": {
|
|
"buckets": {
|
|
"items": {
|
|
"properties": {
|
|
"depth": {
|
|
"type": "number"
|
|
},
|
|
"pageH": {
|
|
"type": "number"
|
|
},
|
|
"pageW": {
|
|
"type": "number"
|
|
},
|
|
"sessions": {
|
|
"type": "number"
|
|
},
|
|
"viewportH": {
|
|
"type": "number"
|
|
},
|
|
"viewportW": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"depth",
|
|
"sessions",
|
|
"pageW",
|
|
"pageH",
|
|
"viewportW",
|
|
"viewportH"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"pageH": {
|
|
"type": "number"
|
|
},
|
|
"pageW": {
|
|
"type": "number"
|
|
},
|
|
"totalSessions": {
|
|
"type": "number"
|
|
},
|
|
"viewportH": {
|
|
"type": "number"
|
|
},
|
|
"viewportW": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"buckets",
|
|
"totalSessions",
|
|
"pageW",
|
|
"pageH",
|
|
"viewportW",
|
|
"viewportH"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"snapshot": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"const": "iframe"
|
|
},
|
|
"pageH": {
|
|
"type": "number"
|
|
},
|
|
"pageW": {
|
|
"type": "number"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"viewportH": {
|
|
"type": "number"
|
|
},
|
|
"viewportW": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"kind",
|
|
"id",
|
|
"url",
|
|
"pageW",
|
|
"pageH",
|
|
"viewportW",
|
|
"viewportH"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"mode",
|
|
"pages",
|
|
"points",
|
|
"snapshot",
|
|
"scroll"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Create or update reports heatmap",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/reports/heatmap/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/reports/journey": {
|
|
"post": {
|
|
"operationId": "runJourneyReport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"filters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"websiteId",
|
|
"filters",
|
|
"type",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"e1": {
|
|
"type": "string"
|
|
},
|
|
"e2": {
|
|
"type": "string"
|
|
},
|
|
"e3": {
|
|
"type": "string"
|
|
},
|
|
"e4": {
|
|
"type": "string"
|
|
},
|
|
"e5": {
|
|
"type": "string"
|
|
},
|
|
"e6": {
|
|
"type": "string"
|
|
},
|
|
"e7": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"e1",
|
|
"e2",
|
|
"e3",
|
|
"e4",
|
|
"e5",
|
|
"e6",
|
|
"e7",
|
|
"count"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Create or update reports journey",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/reports/journey/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/reports/performance": {
|
|
"post": {
|
|
"operationId": "runPerformanceReport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"filters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"websiteId",
|
|
"filters",
|
|
"type",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"browsers": {},
|
|
"chart": {},
|
|
"devices": {},
|
|
"pages": {},
|
|
"pageTitles": {},
|
|
"summary": {}
|
|
},
|
|
"required": [
|
|
"chart",
|
|
"summary",
|
|
"pages",
|
|
"pageTitles",
|
|
"devices",
|
|
"browsers"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Create or update reports performance",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/reports/performance/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/reports/retention": {
|
|
"post": {
|
|
"operationId": "runRetentionReport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"filters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"websiteId",
|
|
"filters",
|
|
"type",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"date": {
|
|
"type": "string"
|
|
},
|
|
"day": {
|
|
"type": "number"
|
|
},
|
|
"percentage": {
|
|
"type": "number"
|
|
},
|
|
"returnVisitors": {
|
|
"type": "number"
|
|
},
|
|
"visitors": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"date",
|
|
"day",
|
|
"visitors",
|
|
"returnVisitors",
|
|
"percentage"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Create or update reports retention",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/reports/retention/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/reports/revenue": {
|
|
"post": {
|
|
"operationId": "runRevenueReport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"filters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"websiteId",
|
|
"filters",
|
|
"type",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"channel": {
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"value"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"chart": {
|
|
"items": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"t": {
|
|
"type": "string"
|
|
},
|
|
"x": {
|
|
"type": "string"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"x",
|
|
"t",
|
|
"y",
|
|
"count"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"country": {
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"value"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"referrer": {
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"value"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"region": {
|
|
"items": {
|
|
"properties": {
|
|
"country": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"value",
|
|
"country"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"total": {}
|
|
},
|
|
"required": [
|
|
"chart",
|
|
"total",
|
|
"country",
|
|
"region",
|
|
"referrer",
|
|
"channel"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Create or update reports revenue",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/reports/revenue/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/reports/utm": {
|
|
"post": {
|
|
"operationId": "runUtmReport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"filters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"websiteId",
|
|
"filters",
|
|
"type",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"utm_campaign": {
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
"utm_content": {
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
"utm_medium": {
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
"utm_source": {
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
"utm_term": {
|
|
"items": {},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"utm_source",
|
|
"utm_medium",
|
|
"utm_campaign",
|
|
"utm_term",
|
|
"utm_content"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Create or update reports utm",
|
|
"tags": [
|
|
"Reports"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/reports/utm/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/scripts/telemetry": {
|
|
"get": {
|
|
"operationId": "getScriptsTelemetry",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"text/javascript": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"description": "Successful response. The response shape is inferred as free-form because the handler does not expose a reusable response schema."
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Get scripts telemetry",
|
|
"tags": [
|
|
"Scripts"
|
|
],
|
|
"x-umami-audience": "internal",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/scripts/telemetry/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/send": {
|
|
"post": {
|
|
"operationId": "send",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"payload": {
|
|
"properties": {
|
|
"browser": {
|
|
"type": "string"
|
|
},
|
|
"cls": {
|
|
"maximum": 100,
|
|
"minimum": 0,
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"device": {
|
|
"type": "string"
|
|
},
|
|
"fcp": {
|
|
"maximum": 60000,
|
|
"minimum": 0,
|
|
"type": "number"
|
|
},
|
|
"hostname": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"inp": {
|
|
"maximum": 60000,
|
|
"minimum": 0,
|
|
"type": "number"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"language": {
|
|
"type": "string"
|
|
},
|
|
"lcp": {
|
|
"maximum": 60000,
|
|
"minimum": 0,
|
|
"type": "number"
|
|
},
|
|
"link": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
},
|
|
"name": {},
|
|
"os": {
|
|
"type": "string"
|
|
},
|
|
"pixel": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
},
|
|
"referrer": {
|
|
"type": "string"
|
|
},
|
|
"screen": {
|
|
"type": "string"
|
|
},
|
|
"tag": {},
|
|
"timestamp": {
|
|
"type": "integer"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
},
|
|
"ttfb": {
|
|
"maximum": 60000,
|
|
"minimum": 0,
|
|
"type": "number"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"userAgent": {
|
|
"type": "string"
|
|
},
|
|
"website": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"event",
|
|
"identify",
|
|
"performance"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"payload"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"properties": {
|
|
"beep": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"beep"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"cache": {},
|
|
"sessionId": {},
|
|
"visitId": {}
|
|
},
|
|
"required": [
|
|
"cache",
|
|
"sessionId",
|
|
"visitId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"403": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "forbidden",
|
|
"message": "Forbidden.",
|
|
"status": 403
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Forbidden."
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "server-error",
|
|
"message": "Server error.",
|
|
"status": 500
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Server error."
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Create or update send",
|
|
"tags": [
|
|
"Collection"
|
|
],
|
|
"x-umami-audience": "collect",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/send/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/share": {
|
|
"post": {
|
|
"operationId": "createShare",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"entityId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 200,
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"shareType": {
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"maxLength": 100,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"entityId",
|
|
"shareType",
|
|
"name",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"entityId": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"shareType": {
|
|
"type": "number"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"slug",
|
|
"parameters",
|
|
"entityId",
|
|
"shareType"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update share",
|
|
"tags": [
|
|
"Shares"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/share/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/share/{slug}": {
|
|
"get": {
|
|
"operationId": "getShareBySlug",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "slug",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": {},
|
|
"properties": {},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Get share slug",
|
|
"tags": [
|
|
"Shares"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/share/[slug]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/share/id/{shareId}": {
|
|
"delete": {
|
|
"operationId": "deleteShare",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "shareId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"const": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Delete share id share id",
|
|
"tags": [
|
|
"Shares"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/share/id/[shareId]/contract.generated.ts"
|
|
},
|
|
"get": {
|
|
"operationId": "getShare",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "shareId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"entityId": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"shareType": {
|
|
"type": "number"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"slug",
|
|
"parameters",
|
|
"entityId",
|
|
"shareType"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get share id share id",
|
|
"tags": [
|
|
"Shares"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/share/id/[shareId]/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "updateShare",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "shareId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"maxLength": 200,
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"slug": {
|
|
"maxLength": 100,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"slug",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"entityId": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"shareType": {
|
|
"type": "number"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"slug",
|
|
"parameters",
|
|
"entityId",
|
|
"shareType"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update share id share id",
|
|
"tags": [
|
|
"Shares"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/share/id/[shareId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/teams": {
|
|
"get": {
|
|
"operationId": "getTeams",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"accessCode": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"twoFactorRequired": {
|
|
"type": "boolean"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"logoUrl",
|
|
"twoFactorRequired",
|
|
"deletedAt",
|
|
"name",
|
|
"accessCode"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Get teams",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "createTeam",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"maxLength": 50,
|
|
"type": "string"
|
|
},
|
|
"ownerId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"maxItems": 2,
|
|
"minItems": 2,
|
|
"prefixItems": [
|
|
{
|
|
"properties": {
|
|
"accessCode": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"twoFactorRequired": {
|
|
"type": "boolean"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"logoUrl",
|
|
"twoFactorRequired",
|
|
"deletedAt",
|
|
"name",
|
|
"accessCode"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"role",
|
|
"teamId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
],
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update teams",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/teams/{teamId}": {
|
|
"delete": {
|
|
"operationId": "deleteTeam",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "teamId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"const": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Delete teams team id",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/[teamId]/contract.generated.ts"
|
|
},
|
|
"get": {
|
|
"operationId": "getTeam",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "teamId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"accessCode": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"twoFactorRequired": {
|
|
"type": "boolean"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"logoUrl",
|
|
"twoFactorRequired",
|
|
"deletedAt",
|
|
"name",
|
|
"accessCode"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get teams team id",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/[teamId]/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "updateTeam",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "teamId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"accessCode": {
|
|
"maxLength": 50,
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"maxLength": 50,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"accessCode": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"twoFactorRequired": {
|
|
"type": "boolean"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"logoUrl",
|
|
"twoFactorRequired",
|
|
"deletedAt",
|
|
"name",
|
|
"accessCode"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update teams team id",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/[teamId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/teams/{teamId}/boards": {
|
|
"get": {
|
|
"operationId": "getTeamBoards",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "teamId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"teamId",
|
|
"type",
|
|
"description",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get teams team id boards",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/[teamId]/boards/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/teams/{teamId}/links": {
|
|
"get": {
|
|
"operationId": "getTeamLinks",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "teamId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"name",
|
|
"teamId",
|
|
"url",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get teams team id links",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/[teamId]/links/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/teams/{teamId}/pixels": {
|
|
"get": {
|
|
"operationId": "getTeamPixels",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "teamId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"name",
|
|
"teamId",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get teams team id pixels",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/[teamId]/pixels/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/teams/{teamId}/users": {
|
|
"get": {
|
|
"operationId": "getTeamUsers",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "teamId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"allOf": [
|
|
{
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"role",
|
|
"teamId"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"user": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get teams team id users",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/[teamId]/users/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "createTeamUser",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "teamId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"role": {
|
|
"enum": [
|
|
"team-member",
|
|
"team-view-only",
|
|
"team-manager"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"userId",
|
|
"role"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"role",
|
|
"teamId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update teams team id users",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/[teamId]/users/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/teams/{teamId}/users/{userId}": {
|
|
"delete": {
|
|
"operationId": "deleteTeamUser",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "teamId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "userId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"const": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Delete teams team id users user id",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/[teamId]/users/[userId]/contract.generated.ts"
|
|
},
|
|
"get": {
|
|
"operationId": "getTeamUser",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "teamId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "userId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"role",
|
|
"teamId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Get teams team id users user id",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/[teamId]/users/[userId]/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "updateTeamUser",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "teamId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "userId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"role": {
|
|
"enum": [
|
|
"team-member",
|
|
"team-view-only",
|
|
"team-manager"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"role"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"role",
|
|
"teamId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update teams team id users user id",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/[teamId]/users/[userId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/teams/{teamId}/websites": {
|
|
"get": {
|
|
"operationId": "getTeamWebsites",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "teamId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"allOf": [
|
|
{
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"createdBy": {
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"domain": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"recorderEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"replayConfig": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"resetAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"createdBy",
|
|
"name",
|
|
"domain",
|
|
"resetAt",
|
|
"teamId",
|
|
"recorderEnabled",
|
|
"replayConfig"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"createUser": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"shareId": {
|
|
"type": "string"
|
|
},
|
|
"team": {
|
|
"properties": {
|
|
"members": {
|
|
"items": {
|
|
"properties": {
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"userId",
|
|
"role"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"members"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"user": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"shareId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get teams team id websites",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/[teamId]/websites/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/teams/join": {
|
|
"post": {
|
|
"operationId": "joinTeam",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"accessCode": {
|
|
"maxLength": 50,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"accessCode"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"role",
|
|
"teamId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update teams join",
|
|
"tags": [
|
|
"Teams"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/teams/join/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/users": {
|
|
"post": {
|
|
"operationId": "createUser",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"id": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"maxLength": 255,
|
|
"minLength": 8,
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"enum": [
|
|
"admin",
|
|
"user",
|
|
"view-only"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"maxLength": 255,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"username",
|
|
"password",
|
|
"role"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username",
|
|
"role"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/users/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/users/{userId}": {
|
|
"delete": {
|
|
"operationId": "deleteUser",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "userId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"const": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Delete users user id",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/users/[userId]/contract.generated.ts"
|
|
},
|
|
"get": {
|
|
"operationId": "getUser",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "userId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"_count": {
|
|
"properties": {
|
|
"apiKeys": {
|
|
"type": "number"
|
|
},
|
|
"boards": {
|
|
"type": "number"
|
|
},
|
|
"createdBy": {
|
|
"type": "number"
|
|
},
|
|
"links": {
|
|
"type": "number"
|
|
},
|
|
"oauthAuthorizationCodes": {
|
|
"type": "number"
|
|
},
|
|
"oauthRefreshTokens": {
|
|
"type": "number"
|
|
},
|
|
"pixels": {
|
|
"type": "number"
|
|
},
|
|
"reports": {
|
|
"type": "number"
|
|
},
|
|
"teams": {
|
|
"type": "number"
|
|
},
|
|
"twoFactorAuth": {
|
|
"type": "number"
|
|
},
|
|
"twoFactorBackupCodes": {
|
|
"type": "number"
|
|
},
|
|
"twoFactorOtpUseds": {
|
|
"type": "number"
|
|
},
|
|
"twoFactorRateLimit": {
|
|
"type": "number"
|
|
},
|
|
"websites": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"websites",
|
|
"createdBy",
|
|
"links",
|
|
"pixels",
|
|
"teams",
|
|
"reports",
|
|
"boards",
|
|
"twoFactorAuth",
|
|
"twoFactorBackupCodes",
|
|
"twoFactorOtpUseds",
|
|
"twoFactorRateLimit",
|
|
"apiKeys",
|
|
"oauthAuthorizationCodes",
|
|
"oauthRefreshTokens"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"apiKeys": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"keyHash": {
|
|
"type": "string"
|
|
},
|
|
"keyPrefix": {
|
|
"type": "string"
|
|
},
|
|
"lastUsedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"name",
|
|
"keyHash",
|
|
"keyPrefix",
|
|
"lastUsedAt"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"boards": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"teamId",
|
|
"type",
|
|
"description",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"createdBy": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"createdBy": {
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"domain": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"recorderEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"replayConfig": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"resetAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"createdBy",
|
|
"name",
|
|
"domain",
|
|
"resetAt",
|
|
"teamId",
|
|
"recorderEnabled",
|
|
"replayConfig"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"links": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"name",
|
|
"teamId",
|
|
"url",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"oauthAuthorizationCodes": {
|
|
"items": {
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "string"
|
|
},
|
|
"codeChallenge": {
|
|
"type": "string"
|
|
},
|
|
"codeChallengeMethod": {
|
|
"type": "string"
|
|
},
|
|
"codeHash": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"expiresAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"redirectUri": {
|
|
"type": "string"
|
|
},
|
|
"resource": {
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"type": "string"
|
|
},
|
|
"usedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"codeHash",
|
|
"expiresAt",
|
|
"clientId",
|
|
"redirectUri",
|
|
"scope",
|
|
"resource",
|
|
"codeChallenge",
|
|
"codeChallengeMethod",
|
|
"usedAt"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"oauthRefreshTokens": {
|
|
"items": {
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"expiresAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"lastUsedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"resource": {
|
|
"type": "string"
|
|
},
|
|
"revokedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"type": "string"
|
|
},
|
|
"tokenHash": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"expiresAt",
|
|
"lastUsedAt",
|
|
"clientId",
|
|
"scope",
|
|
"resource",
|
|
"tokenHash",
|
|
"revokedAt"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"password": {
|
|
"type": "string"
|
|
},
|
|
"pixels": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"name",
|
|
"teamId",
|
|
"slug"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"reports": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"type",
|
|
"description",
|
|
"parameters",
|
|
"websiteId"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"teams": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"role",
|
|
"teamId"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"twoFactorAuth": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"isEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"secret": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"isEnabled",
|
|
"id",
|
|
"userId",
|
|
"secret",
|
|
"createdAt",
|
|
"updatedAt"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"twoFactorBackupCodes": {
|
|
"items": {
|
|
"properties": {
|
|
"codeHash": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"used": {
|
|
"type": "boolean"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"codeHash",
|
|
"used"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"twoFactorOtpUseds": {
|
|
"items": {
|
|
"properties": {
|
|
"expiresAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"otp": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"otp",
|
|
"expiresAt"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"twoFactorRateLimit": {
|
|
"properties": {
|
|
"attempts": {
|
|
"type": "number"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"lockedUntil": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"updatedAt",
|
|
"attempts",
|
|
"lockedUntil"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"twoFactorRequired": {
|
|
"type": "boolean"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
},
|
|
"websites": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"createdBy": {
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"domain": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"recorderEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"replayConfig": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"resetAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"createdBy",
|
|
"name",
|
|
"domain",
|
|
"resetAt",
|
|
"teamId",
|
|
"recorderEnabled",
|
|
"replayConfig"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"twoFactorAuth",
|
|
"twoFactorRateLimit",
|
|
"id",
|
|
"createdAt",
|
|
"username",
|
|
"password",
|
|
"role",
|
|
"twoFactorRequired",
|
|
"websites",
|
|
"createdBy",
|
|
"links",
|
|
"pixels",
|
|
"teams",
|
|
"reports",
|
|
"boards",
|
|
"twoFactorBackupCodes",
|
|
"twoFactorOtpUseds",
|
|
"apiKeys",
|
|
"oauthAuthorizationCodes",
|
|
"oauthRefreshTokens",
|
|
"_count"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get users user id",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/users/[userId]/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "updateUser",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "userId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"password": {
|
|
"maxLength": 255,
|
|
"minLength": 8,
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"enum": [
|
|
"admin",
|
|
"user",
|
|
"view-only"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"maxLength": 255,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"username",
|
|
"role"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update users user id",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/users/[userId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/users/{userId}/teams": {
|
|
"get": {
|
|
"operationId": "getUserTeams",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "userId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"accessCode": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"twoFactorRequired": {
|
|
"type": "boolean"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"logoUrl",
|
|
"twoFactorRequired",
|
|
"deletedAt",
|
|
"name",
|
|
"accessCode"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Get users user id teams",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/users/[userId]/teams/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/users/{userId}/websites": {
|
|
"get": {
|
|
"operationId": "getUserWebsites",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "userId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "includeTeams",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"allOf": [
|
|
{
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"createdBy": {
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"domain": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"recorderEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"replayConfig": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"resetAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"createdBy",
|
|
"name",
|
|
"domain",
|
|
"resetAt",
|
|
"teamId",
|
|
"recorderEnabled",
|
|
"replayConfig"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"createUser": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"shareId": {
|
|
"type": "string"
|
|
},
|
|
"team": {
|
|
"properties": {
|
|
"members": {
|
|
"items": {
|
|
"properties": {
|
|
"role": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"userId",
|
|
"role"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"members"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"user": {
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"username"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"shareId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Get users user id websites",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/users/[userId]/websites/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites": {
|
|
"get": {
|
|
"description": "Returns websites owned by the authenticated user.",
|
|
"operationId": "listWebsites",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"schema": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"schema": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"schema": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "orderBy",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "sortDescending",
|
|
"schema": {
|
|
"enum": [
|
|
"true",
|
|
"false"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"description": "When present, include websites accessible through owned or managed teams.",
|
|
"in": "query",
|
|
"name": "includeTeams",
|
|
"schema": {
|
|
"description": "When present, include websites accessible through owned or managed teams.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WebsitePage"
|
|
}
|
|
}
|
|
},
|
|
"description": "A page of websites."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"websites:read"
|
|
]
|
|
}
|
|
],
|
|
"summary": "List websites",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "websites:read",
|
|
"x-umami-source": "src/app/api/websites/contract.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "createWebsite",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateWebsiteRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Website"
|
|
}
|
|
}
|
|
},
|
|
"description": "Website created."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create a website",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/contract.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}": {
|
|
"delete": {
|
|
"operationId": "deleteWebsite",
|
|
"parameters": [
|
|
{
|
|
"description": "Website ID.",
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"description": "Website ID.",
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Ok"
|
|
}
|
|
}
|
|
},
|
|
"description": "Website deleted."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Delete a website",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/contract.ts"
|
|
},
|
|
"get": {
|
|
"operationId": "getWebsite",
|
|
"parameters": [
|
|
{
|
|
"description": "Website ID.",
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"description": "Website ID.",
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/components/schemas/Website"
|
|
},
|
|
{
|
|
"type": "null"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"description": "Website details, or null if it does not exist."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"websites:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get a website",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "websites:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/contract.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "updateWebsite",
|
|
"parameters": [
|
|
{
|
|
"description": "Website ID.",
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"description": "Website ID.",
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/UpdateWebsiteRequest"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/Website"
|
|
}
|
|
}
|
|
},
|
|
"description": "Website updated."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "server-error",
|
|
"message": "Server error.",
|
|
"status": 500
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Server error."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Update a website",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/contract.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/active": {
|
|
"get": {
|
|
"description": "Returns the number of visitors active on the website in the last few minutes.",
|
|
"operationId": "getWebsiteActive",
|
|
"parameters": [
|
|
{
|
|
"description": "Website ID.",
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"description": "Website ID.",
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ActiveVisitors"
|
|
}
|
|
}
|
|
},
|
|
"description": "Active visitor count."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get current active visitors",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/active/contract.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/annotations": {
|
|
"get": {
|
|
"operationId": "getWebsiteAnnotations",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"allDay": {
|
|
"type": "boolean"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"date": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"note": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"websiteId",
|
|
"date",
|
|
"allDay",
|
|
"note"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id annotations",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/annotations/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "createWebsiteAnnotation",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"allDay": {
|
|
"type": "boolean"
|
|
},
|
|
"date": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"note": {
|
|
"maxLength": 500,
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"date",
|
|
"note"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"allDay": {
|
|
"type": "boolean"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"date": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"note": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"websiteId",
|
|
"date",
|
|
"allDay",
|
|
"note"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update websites website id annotations",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/annotations/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/annotations/{annotationId}": {
|
|
"delete": {
|
|
"operationId": "deleteWebsiteAnnotation",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "annotationId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"const": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Delete websites website id annotations annotation id",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/annotations/[annotationId]/contract.generated.ts"
|
|
},
|
|
"get": {
|
|
"operationId": "getWebsiteAnnotation",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "annotationId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"allDay": {
|
|
"type": "boolean"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"date": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"note": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"websiteId",
|
|
"date",
|
|
"allDay",
|
|
"note"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id annotations annotation id",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/annotations/[annotationId]/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "updateWebsiteAnnotation",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "annotationId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"allDay": {
|
|
"type": "boolean"
|
|
},
|
|
"date": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"note": {
|
|
"maxLength": 500,
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"date",
|
|
"note"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"allDay": {
|
|
"type": "boolean"
|
|
},
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"date": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"note": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"websiteId",
|
|
"date",
|
|
"allDay",
|
|
"note"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update websites website id annotations annotation id",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/annotations/[annotationId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/daterange": {
|
|
"get": {
|
|
"operationId": "getWebsiteDateRange",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"endDate": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"startDate": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"startDate",
|
|
"endDate"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id daterange",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/daterange/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/event-data": {
|
|
"get": {
|
|
"operationId": "getEventData",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"eventId": {
|
|
"type": "string"
|
|
},
|
|
"eventName": {
|
|
"type": "string"
|
|
},
|
|
"eventProperties": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"dataKey": {
|
|
"type": "string"
|
|
},
|
|
"dataType": {
|
|
"type": "number"
|
|
},
|
|
"dateValue": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"numberValue": {
|
|
"type": "number"
|
|
},
|
|
"stringValue": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"createdAt",
|
|
"dataKey",
|
|
"stringValue",
|
|
"numberValue",
|
|
"dateValue",
|
|
"dataType"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"websiteId",
|
|
"eventId",
|
|
"eventName",
|
|
"eventProperties"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id event data",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/event-data/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/event-data-pivot": {
|
|
"get": {
|
|
"operationId": "getEventDataPivot",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"eventId": {
|
|
"type": "string"
|
|
},
|
|
"eventName": {
|
|
"type": "string"
|
|
},
|
|
"propertyKeys": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"propertyValues": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"sessionId": {
|
|
"type": "string"
|
|
},
|
|
"urlPath": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventId",
|
|
"sessionId",
|
|
"eventName",
|
|
"urlPath",
|
|
"createdAt",
|
|
"propertyKeys",
|
|
"propertyValues"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id event data pivot",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/event-data-pivot/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/event-data-pivot/array-series": {
|
|
"get": {
|
|
"operationId": "getEventDataArraySeries",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"t": {
|
|
"type": "string"
|
|
},
|
|
"x": {
|
|
"type": "string"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"x",
|
|
"t",
|
|
"y"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id event data pivot array series",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/event-data-pivot/array-series/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/event-data-pivot/date-series": {
|
|
"get": {
|
|
"operationId": "getEventDataDateSeries",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"t": {
|
|
"type": "string"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"t",
|
|
"y"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id event data pivot date series",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/event-data-pivot/date-series/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/event-data-pivot/numeric-series": {
|
|
"get": {
|
|
"operationId": "getEventDataNumericSeries",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "metric",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"sum",
|
|
"avg",
|
|
"count"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"t": {
|
|
"type": "string"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"t",
|
|
"y"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id event data pivot numeric series",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/event-data-pivot/numeric-series/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/event-data-pivot/numeric-stats": {
|
|
"get": {
|
|
"operationId": "getEventDataNumericStats",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"average": {
|
|
"type": "number"
|
|
},
|
|
"max": {
|
|
"type": "number"
|
|
},
|
|
"median": {
|
|
"type": "number"
|
|
},
|
|
"min": {
|
|
"type": "number"
|
|
},
|
|
"total": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"total",
|
|
"average",
|
|
"median",
|
|
"max",
|
|
"min"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id event data pivot numeric stats",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/event-data-pivot/numeric-stats/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/event-data-pivot/property-series": {
|
|
"get": {
|
|
"operationId": "getEventDataPropertySeries",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"t": {
|
|
"type": "string"
|
|
},
|
|
"x": {
|
|
"type": "string"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"x",
|
|
"t",
|
|
"y"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id event data pivot property series",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/event-data-pivot/property-series/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/event-data/{eventId}": {
|
|
"get": {
|
|
"operationId": "getEventDataById",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "eventId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"dataKey": {
|
|
"type": "string"
|
|
},
|
|
"dataType": {
|
|
"type": "number"
|
|
},
|
|
"dateValue": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"numberValue": {
|
|
"properties": {
|
|
"d": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"e": {
|
|
"type": "number"
|
|
},
|
|
"s": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"d",
|
|
"e",
|
|
"s"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"stringValue": {
|
|
"type": "string"
|
|
},
|
|
"websiteEventId": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"websiteId",
|
|
"websiteEventId",
|
|
"dataKey",
|
|
"stringValue",
|
|
"numberValue",
|
|
"dateValue",
|
|
"dataType"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id event data event id",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/event-data/[eventId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/event-data/events": {
|
|
"get": {
|
|
"operationId": "getEventDataEvents",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"dataType": {
|
|
"type": "number"
|
|
},
|
|
"eventName": {
|
|
"type": "string"
|
|
},
|
|
"propertyName": {
|
|
"type": "string"
|
|
},
|
|
"propertyValue": {
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"propertyName",
|
|
"dataType",
|
|
"total"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id event data events",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/event-data/events/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/event-data/fields": {
|
|
"get": {
|
|
"operationId": "getEventDataFields",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventName",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"dataType": {
|
|
"type": "number"
|
|
},
|
|
"propertyName": {
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"propertyName",
|
|
"dataType",
|
|
"total"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id event data fields",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/event-data/fields/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/event-data/properties": {
|
|
"get": {
|
|
"operationId": "getEventDataProperties",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"dataType": {
|
|
"type": "number"
|
|
},
|
|
"eventName": {
|
|
"type": "string"
|
|
},
|
|
"propertyName": {
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"eventName",
|
|
"propertyName",
|
|
"dataType",
|
|
"total"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id event data properties",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/event-data/properties/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/event-data/stats": {
|
|
"get": {
|
|
"operationId": "getEventDataStats",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"events": {
|
|
"type": "number"
|
|
},
|
|
"properties": {
|
|
"type": "number"
|
|
},
|
|
"records": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"events",
|
|
"properties",
|
|
"records"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id event data stats",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/event-data/stats/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/event-data/values": {
|
|
"get": {
|
|
"operationId": "getEventDataValues",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventName",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "dataType",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"total": {
|
|
"type": "number"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"value",
|
|
"total"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id event data values",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/event-data/values/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/events": {
|
|
"get": {
|
|
"description": "Returns a page of pageviews and custom events in the date range, newest first. Filter with `event` for a specific event name or `search` for free text.",
|
|
"operationId": "getWebsiteEvents",
|
|
"parameters": [
|
|
{
|
|
"description": "Website ID.",
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"description": "Website ID.",
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"schema": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"schema": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"schema": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"schema": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"schema": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"schema": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WebsiteEventPage"
|
|
}
|
|
}
|
|
},
|
|
"description": "A page of events."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "List tracked events",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/events/contract.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/events/series": {
|
|
"get": {
|
|
"operationId": "getWebsiteEventSeries",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"t": {
|
|
"type": "string"
|
|
},
|
|
"x": {
|
|
"type": "string"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"x",
|
|
"t",
|
|
"y"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id events series",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/events/series/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/events/stats": {
|
|
"get": {
|
|
"operationId": "getWebsiteEventStats",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"properties": {
|
|
"comparison": {
|
|
"items": {
|
|
"properties": {
|
|
"events": {
|
|
"type": "number"
|
|
},
|
|
"uniqueEvents": {
|
|
"type": "number"
|
|
},
|
|
"visitors": {
|
|
"type": "number"
|
|
},
|
|
"visits": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"events",
|
|
"visitors",
|
|
"visits",
|
|
"uniqueEvents"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"comparison",
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id events stats",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/events/stats/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/export": {
|
|
"get": {
|
|
"operationId": "exportWebsite",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"zip": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"zip"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"function toString() { [native code] }": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {}
|
|
}
|
|
},
|
|
"description": "Successful response. The response shape is inferred as free-form because the handler does not expose a reusable response schema."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id export",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/export/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/metrics": {
|
|
"get": {
|
|
"description": "Returns the top values for one dimension (`type`), such as pages, referrers, countries, browsers, UTM parameters or events, ordered by count. Page-type dimensions count views/events; visitor dimensions count unique visitors.",
|
|
"operationId": "getWebsiteMetrics",
|
|
"parameters": [
|
|
{
|
|
"description": "Website ID.",
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"description": "Website ID.",
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"description": "Dimension to rank: path, entry, exit, title, query, hostname, referrer, domain, channel, event, tag, browser, os, device, screen, language, country, region, city, distinctId, utmSource, utmMedium, utmCampaign, utmContent, utmTerm.",
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {
|
|
"description": "Dimension to rank: path, entry, exit, title, query, hostname, referrer, domain, channel, event, tag, browser, os, device, screen, language, country, region, city, distinctId, utmSource, utmMedium, utmCampaign, utmContent, utmTerm.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "limit",
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "offset",
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"schema": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"schema": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"schema": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/MetricRows"
|
|
}
|
|
}
|
|
},
|
|
"description": "Ranked rows."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get ranked metrics for a dimension",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/metrics/contract.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/metrics/expanded": {
|
|
"get": {
|
|
"operationId": "getWebsiteExpandedMetrics",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "offset",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"bounces": {
|
|
"type": "number"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"pageviews": {
|
|
"type": "number"
|
|
},
|
|
"totaltime": {
|
|
"type": "number"
|
|
},
|
|
"visitors": {
|
|
"type": "number"
|
|
},
|
|
"visits": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"pageviews",
|
|
"visitors",
|
|
"visits",
|
|
"bounces",
|
|
"totaltime"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id metrics expanded",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/metrics/expanded/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/pageviews": {
|
|
"get": {
|
|
"description": "Returns pageviews and sessions bucketed by `unit` (minute, hour, day, month, year) in the given `timezone`. When `compare` is set the comparison period is included.",
|
|
"operationId": "getWebsitePageviews",
|
|
"parameters": [
|
|
{
|
|
"description": "Website ID.",
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"description": "Website ID.",
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"schema": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"schema": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"schema": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WebsitePageviews"
|
|
}
|
|
}
|
|
},
|
|
"description": "Time series."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get pageview and session time series",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/pageviews/contract.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/recorder": {
|
|
"get": {
|
|
"operationId": "getWebsiteRecorderConfig",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"properties": {
|
|
"enabled": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"enabled"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"blockSelector": {
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"heatmapEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"heatmapSampleRate": {
|
|
"type": "number"
|
|
},
|
|
"maskLevel": {
|
|
"anyOf": [
|
|
{
|
|
"const": "strict"
|
|
},
|
|
{
|
|
"const": "moderate"
|
|
}
|
|
]
|
|
},
|
|
"maxDuration": {
|
|
"type": "number"
|
|
},
|
|
"replayEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"sampleRate": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"enabled",
|
|
"replayEnabled",
|
|
"heatmapEnabled",
|
|
"sampleRate",
|
|
"heatmapSampleRate",
|
|
"maskLevel",
|
|
"maxDuration",
|
|
"blockSelector"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Get websites website id recorder",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "collect",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/recorder/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/replays": {
|
|
"get": {
|
|
"operationId": "getWebsiteReplays",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "minDuration",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"browser": {
|
|
"type": "string"
|
|
},
|
|
"chunkCount": {
|
|
"type": "number"
|
|
},
|
|
"city": {
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"device": {
|
|
"type": "string"
|
|
},
|
|
"duration": {
|
|
"type": "number"
|
|
},
|
|
"endedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"eventCount": {
|
|
"type": "number"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"os": {
|
|
"type": "string"
|
|
},
|
|
"sessionId": {
|
|
"type": "string"
|
|
},
|
|
"startedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"sessionId",
|
|
"websiteId",
|
|
"browser",
|
|
"os",
|
|
"device",
|
|
"country",
|
|
"city",
|
|
"eventCount",
|
|
"chunkCount",
|
|
"startedAt",
|
|
"endedAt",
|
|
"duration",
|
|
"createdAt"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id replays",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/replays/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/replays/{replayId}": {
|
|
"get": {
|
|
"operationId": "getWebsiteReplay",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "replayId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"chunkCount": {
|
|
"type": "number"
|
|
},
|
|
"endedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"eventCount": {
|
|
"type": "number"
|
|
},
|
|
"events": {
|
|
"items": {},
|
|
"type": "array"
|
|
},
|
|
"sessionId": {
|
|
"type": "string"
|
|
},
|
|
"startedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"sessionId",
|
|
"events",
|
|
"startedAt",
|
|
"endedAt",
|
|
"eventCount",
|
|
"chunkCount"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id replays replay id",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/replays/[replayId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/replays/saved": {
|
|
"get": {
|
|
"operationId": "getWebsiteSavedReplays",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"visitId": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"websiteId",
|
|
"visitId"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id replays saved",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/replays/saved/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/replays/saved/{replayId}": {
|
|
"get": {
|
|
"operationId": "getWebsiteReplaySaved",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "replayId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"isSaved": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"isSaved"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id replays saved replay id",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/replays/saved/[replayId]/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "saveWebsiteReplay",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "replayId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"isSaved": {
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"maxLength": 100,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"isSaved"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update websites website id replays saved replay id",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/replays/saved/[replayId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/reports": {
|
|
"get": {
|
|
"operationId": "getWebsiteReports",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"allOf": [
|
|
{
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"type",
|
|
"description",
|
|
"parameters",
|
|
"websiteId"
|
|
],
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"website": {
|
|
"properties": {
|
|
"domain": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"domain",
|
|
"userId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id reports",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/reports/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/reset": {
|
|
"post": {
|
|
"operationId": "resetWebsite",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"const": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update websites website id reset",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/reset/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/revenue/chart": {
|
|
"get": {
|
|
"operationId": "getWebsiteRevenueChart",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "currency",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"chart": {
|
|
"items": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"t": {
|
|
"type": "string"
|
|
},
|
|
"x": {
|
|
"type": "string"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"x",
|
|
"t",
|
|
"y",
|
|
"count"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"chart"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id revenue chart",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/revenue/chart/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/revenue/metrics": {
|
|
"get": {
|
|
"operationId": "getWebsiteRevenueMetrics",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {
|
|
"enum": [
|
|
"country",
|
|
"region",
|
|
"referrer",
|
|
"channel"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "currency",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"items": {
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"value"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
{
|
|
"items": {
|
|
"properties": {
|
|
"country": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"value",
|
|
"country"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id revenue metrics",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/revenue/metrics/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/revenue/sessions": {
|
|
"get": {
|
|
"operationId": "getWebsiteRevenueSessions",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "currency",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"browser": {
|
|
"type": "string"
|
|
},
|
|
"city": {
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"device": {
|
|
"type": "string"
|
|
},
|
|
"events": {
|
|
"type": "number"
|
|
},
|
|
"firstAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"hostname": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"language": {
|
|
"type": "string"
|
|
},
|
|
"lastAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"os": {
|
|
"type": "string"
|
|
},
|
|
"region": {
|
|
"type": "string"
|
|
},
|
|
"screen": {
|
|
"type": "string"
|
|
},
|
|
"views": {
|
|
"type": "number"
|
|
},
|
|
"visits": {
|
|
"type": "number"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"websiteId",
|
|
"hostname",
|
|
"browser",
|
|
"os",
|
|
"device",
|
|
"screen",
|
|
"language",
|
|
"country",
|
|
"region",
|
|
"city",
|
|
"firstAt",
|
|
"lastAt",
|
|
"visits",
|
|
"views",
|
|
"events",
|
|
"createdAt"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id revenue sessions",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/revenue/sessions/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/revenue/stats": {
|
|
"get": {
|
|
"operationId": "getWebsiteRevenueStats",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "currency",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"comparison": {}
|
|
},
|
|
"required": [
|
|
"comparison"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id revenue stats",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/revenue/stats/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/segments": {
|
|
"get": {
|
|
"operationId": "getWebsiteSegments",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {
|
|
"enum": [
|
|
"segment",
|
|
"cohort"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"type",
|
|
"parameters",
|
|
"websiteId"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id segments",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/segments/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "createWebsiteSegment",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"maxLength": 200,
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"properties": {
|
|
"action": {
|
|
"properties": {
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"value"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"dateRange": {
|
|
"type": "string"
|
|
},
|
|
"filters": {
|
|
"items": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"match": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"segment",
|
|
"cohort"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"name",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"type",
|
|
"parameters",
|
|
"websiteId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update websites website id segments",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/segments/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/segments/{segmentId}": {
|
|
"delete": {
|
|
"operationId": "deleteWebsiteSegment",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "segmentId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"const": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Delete websites website id segments segment id",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/segments/[segmentId]/contract.generated.ts"
|
|
},
|
|
"get": {
|
|
"operationId": "getWebsiteSegment",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "segmentId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"type",
|
|
"parameters",
|
|
"websiteId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id segments segment id",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/segments/[segmentId]/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "updateWebsiteSegment",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "segmentId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"maxLength": 200,
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
},
|
|
"type": {
|
|
"enum": [
|
|
"segment",
|
|
"cohort"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"name",
|
|
"parameters"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"type",
|
|
"parameters",
|
|
"websiteId"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update websites website id segments segment id",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/segments/[segmentId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/session-data-pivot": {
|
|
"get": {
|
|
"operationId": "getSessionDataPivot",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"distinctId": {
|
|
"type": "string"
|
|
},
|
|
"propertyKeys": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"propertyValues": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"sessionId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"sessionId",
|
|
"distinctId",
|
|
"createdAt",
|
|
"propertyKeys",
|
|
"propertyValues"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id session data pivot",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/session-data-pivot/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/session-data/array-series": {
|
|
"get": {
|
|
"operationId": "getSessionDataArraySeries",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"t": {
|
|
"type": "string"
|
|
},
|
|
"x": {
|
|
"type": "string"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"x",
|
|
"t",
|
|
"y"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id session data array series",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/session-data/array-series/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/session-data/date-series": {
|
|
"get": {
|
|
"operationId": "getSessionDataDateSeries",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"t": {
|
|
"type": "string"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"t",
|
|
"y"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id session data date series",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/session-data/date-series/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/session-data/numeric-series": {
|
|
"get": {
|
|
"operationId": "getSessionDataNumericSeries",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "metric",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"sum",
|
|
"avg",
|
|
"count"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"t": {
|
|
"type": "string"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"t",
|
|
"y"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id session data numeric series",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/session-data/numeric-series/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/session-data/numeric-stats": {
|
|
"get": {
|
|
"operationId": "getSessionDataNumericStats",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"average": {
|
|
"type": "number"
|
|
},
|
|
"max": {
|
|
"type": "number"
|
|
},
|
|
"median": {
|
|
"type": "number"
|
|
},
|
|
"min": {
|
|
"type": "number"
|
|
},
|
|
"total": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"total",
|
|
"average",
|
|
"median",
|
|
"max",
|
|
"min"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id session data numeric stats",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/session-data/numeric-stats/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/session-data/properties": {
|
|
"get": {
|
|
"operationId": "getSessionDataProperties",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"dataType": {
|
|
"type": "number"
|
|
},
|
|
"propertyName": {
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"propertyName",
|
|
"dataType",
|
|
"total"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id session data properties",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/session-data/properties/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/session-data/property-series": {
|
|
"get": {
|
|
"operationId": "getSessionDataPropertySeries",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"t": {
|
|
"type": "string"
|
|
},
|
|
"x": {
|
|
"type": "string"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"x",
|
|
"t",
|
|
"y"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id session data property series",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/session-data/property-series/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/session-data/stats": {
|
|
"get": {
|
|
"operationId": "getSessionDataStats",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"activity": {
|
|
"type": "number"
|
|
},
|
|
"events": {
|
|
"type": "number"
|
|
},
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"sessions": {
|
|
"type": "number"
|
|
},
|
|
"views": {
|
|
"type": "number"
|
|
},
|
|
"visits": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"activity",
|
|
"sessions",
|
|
"visits",
|
|
"views",
|
|
"events"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id session data stats",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/session-data/stats/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/session-data/values": {
|
|
"get": {
|
|
"operationId": "getSessionDataValues",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "propertyName",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "dataType",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"total": {
|
|
"type": "number"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"value",
|
|
"total"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id session data values",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/session-data/values/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/sessions": {
|
|
"get": {
|
|
"description": "Returns a page of visitor sessions in the date range, newest first. `search` matches distinct ID, city, browser, OS or device.",
|
|
"operationId": "getWebsiteSessions",
|
|
"parameters": [
|
|
{
|
|
"description": "Website ID.",
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"description": "Website ID.",
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"schema": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"schema": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"schema": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"schema": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"schema": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"schema": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WebsiteSessionPage"
|
|
}
|
|
}
|
|
},
|
|
"description": "A page of sessions."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "List visitor sessions",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/sessions/contract.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/sessions/{sessionId}": {
|
|
"delete": {
|
|
"operationId": "deleteWebsiteSession",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "sessionId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"ok": {
|
|
"const": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ok"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Delete websites website id sessions session id",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/sessions/[sessionId]/contract.generated.ts"
|
|
},
|
|
"get": {
|
|
"operationId": "getWebsiteSession",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "sessionId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"canDelete": {},
|
|
"stitchedSessionCount": {}
|
|
},
|
|
"required": [
|
|
"canDelete",
|
|
"stitchedSessionCount"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "not-found",
|
|
"message": "Not found.",
|
|
"status": 404
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id sessions session id",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/sessions/[sessionId]/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/sessions/{sessionId}/activity": {
|
|
"get": {
|
|
"operationId": "getWebsiteSessionActivity",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "sessionId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"eventId": {
|
|
"type": "string"
|
|
},
|
|
"eventName": {
|
|
"type": "string"
|
|
},
|
|
"eventType": {
|
|
"type": "number"
|
|
},
|
|
"hasData": {
|
|
"type": "boolean"
|
|
},
|
|
"hostname": {
|
|
"type": "string"
|
|
},
|
|
"referrerDomain": {
|
|
"type": "string"
|
|
},
|
|
"urlPath": {
|
|
"type": "string"
|
|
},
|
|
"urlQuery": {
|
|
"type": "string"
|
|
},
|
|
"visitId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"createdAt",
|
|
"urlPath",
|
|
"urlQuery",
|
|
"referrerDomain",
|
|
"eventId",
|
|
"eventType",
|
|
"eventName",
|
|
"visitId",
|
|
"hostname",
|
|
"hasData"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id sessions session id activity",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/sessions/[sessionId]/activity/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/sessions/{sessionId}/properties": {
|
|
"get": {
|
|
"operationId": "getWebsiteSessionProperties",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "sessionId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"dataKey": {
|
|
"type": "string"
|
|
},
|
|
"dataType": {
|
|
"type": "number"
|
|
},
|
|
"dateValue": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"numberValue": {
|
|
"type": "number"
|
|
},
|
|
"sessionId": {
|
|
"type": "string"
|
|
},
|
|
"stringValue": {
|
|
"type": "string"
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"websiteId",
|
|
"sessionId",
|
|
"dataKey",
|
|
"dataType",
|
|
"stringValue",
|
|
"numberValue",
|
|
"dateValue",
|
|
"createdAt"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id sessions session id properties",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/sessions/[sessionId]/properties/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/sessions/{sessionId}/replays": {
|
|
"get": {
|
|
"operationId": "getWebsiteSessionReplays",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "path",
|
|
"name": "sessionId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"browser": {
|
|
"type": "string"
|
|
},
|
|
"chunkCount": {
|
|
"type": "number"
|
|
},
|
|
"city": {
|
|
"type": "string"
|
|
},
|
|
"country": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"device": {
|
|
"type": "string"
|
|
},
|
|
"duration": {
|
|
"type": "number"
|
|
},
|
|
"endedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"eventCount": {
|
|
"type": "number"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"os": {
|
|
"type": "string"
|
|
},
|
|
"sessionId": {
|
|
"type": "string"
|
|
},
|
|
"startedAt": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"websiteId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"sessionId",
|
|
"websiteId",
|
|
"browser",
|
|
"os",
|
|
"device",
|
|
"country",
|
|
"city",
|
|
"eventCount",
|
|
"chunkCount",
|
|
"startedAt",
|
|
"endedAt",
|
|
"duration",
|
|
"createdAt"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id sessions session id replays",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/sessions/[sessionId]/replays/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/sessions/stats": {
|
|
"get": {
|
|
"operationId": "getWebsiteSessionStats",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id sessions stats",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/sessions/stats/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/sessions/weekly": {
|
|
"get": {
|
|
"operationId": "getWebsiteSessionsWeekly",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id sessions weekly",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/sessions/weekly/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/shares": {
|
|
"get": {
|
|
"operationId": "getWebsiteShares",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "page",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "pageSize",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "maxResults",
|
|
"required": false,
|
|
"schema": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"count": {
|
|
"type": "number"
|
|
},
|
|
"data": {
|
|
"items": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"entityId": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"shareType": {
|
|
"type": "number"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"slug",
|
|
"parameters",
|
|
"entityId",
|
|
"shareType"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"isCapped": {
|
|
"type": "boolean"
|
|
},
|
|
"orderBy": {
|
|
"type": "string"
|
|
},
|
|
"page": {
|
|
"type": "number"
|
|
},
|
|
"pageSize": {
|
|
"type": "number"
|
|
},
|
|
"search": {
|
|
"type": "string"
|
|
},
|
|
"sortDescending": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"data",
|
|
"count",
|
|
"page",
|
|
"pageSize"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id shares",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/shares/contract.generated.ts"
|
|
},
|
|
"post": {
|
|
"operationId": "createWebsiteShare",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"name": {
|
|
"maxLength": 200,
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"entityId": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parameters": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"shareType": {
|
|
"type": "number"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"name",
|
|
"slug",
|
|
"parameters",
|
|
"entityId",
|
|
"shareType"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update websites website id shares",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/shares/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/stats": {
|
|
"get": {
|
|
"description": "Returns pageviews, unique visitors, visits, bounces and total time on site for the date range, plus the same totals for the comparison period (`compare`: prev or yoy).",
|
|
"operationId": "getWebsiteStats",
|
|
"parameters": [
|
|
{
|
|
"description": "Website ID.",
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"description": "Website ID.",
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "path",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "referrer",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "title",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "os",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "browser",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "device",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "country",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "region",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "city",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "tag",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "hostname",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "distinctId",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "language",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "event",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmSource",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmMedium",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmCampaign",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmContent",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "utmTerm",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "segment",
|
|
"schema": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "cohort",
|
|
"schema": {
|
|
"format": "uuid",
|
|
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "eventType",
|
|
"schema": {
|
|
"exclusiveMinimum": 0,
|
|
"maximum": 9007199254740991,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "excludeBounce",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "match",
|
|
"schema": {
|
|
"enum": [
|
|
"all",
|
|
"any"
|
|
],
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/WebsiteStats"
|
|
}
|
|
}
|
|
},
|
|
"description": "Summary stats with comparison."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"oauth2": [
|
|
"analytics:read"
|
|
]
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get website summary stats",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-oauth-scope": "analytics:read",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/stats/contract.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/transfer": {
|
|
"post": {
|
|
"operationId": "transferWebsite",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"teamId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"format": "uuid",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"createdAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"createdBy": {
|
|
"type": "string"
|
|
},
|
|
"deletedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"domain": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"recorderEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"replayConfig": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"const": false
|
|
},
|
|
{
|
|
"const": true
|
|
},
|
|
{},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
{
|
|
"properties": {
|
|
"length": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"length"
|
|
],
|
|
"type": "object"
|
|
}
|
|
]
|
|
},
|
|
"resetAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"teamId": {
|
|
"type": "string"
|
|
},
|
|
"updatedAt": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"userId",
|
|
"createdAt",
|
|
"updatedAt",
|
|
"deletedAt",
|
|
"createdBy",
|
|
"name",
|
|
"domain",
|
|
"resetAt",
|
|
"teamId",
|
|
"recorderEnabled",
|
|
"replayConfig"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
],
|
|
"summary": "Create or update websites website id transfer",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/transfer/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/{websiteId}/values": {
|
|
"get": {
|
|
"operationId": "getWebsiteValues",
|
|
"parameters": [
|
|
{
|
|
"in": "path",
|
|
"name": "websiteId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endDate",
|
|
"required": false,
|
|
"schema": {
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "unit",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "compare",
|
|
"required": false,
|
|
"schema": {
|
|
"enum": [
|
|
"prev",
|
|
"yoy"
|
|
],
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"items": {},
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites website id values",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/[websiteId]/values/contract.generated.ts"
|
|
}
|
|
},
|
|
"/api/websites/charts": {
|
|
"get": {
|
|
"operationId": "getWebsitesCharts",
|
|
"parameters": [
|
|
{
|
|
"in": "query",
|
|
"name": "ids",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "startAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "endAt",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
{
|
|
"in": "query",
|
|
"name": "timezone",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"data": {
|
|
"additionalProperties": {
|
|
"properties": {
|
|
"total": {
|
|
"type": "number"
|
|
},
|
|
"values": {
|
|
"items": {
|
|
"type": "number"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"required": [
|
|
"values",
|
|
"total"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"properties": {},
|
|
"type": "object"
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
],
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "The operation completed successfully."
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "bad-request",
|
|
"message": "Bad request.",
|
|
"status": 400
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Bad request."
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"error": {
|
|
"code": "unauthorized",
|
|
"message": "Unauthorized.",
|
|
"status": 401
|
|
}
|
|
},
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ApiError"
|
|
}
|
|
}
|
|
},
|
|
"description": "Unauthorized."
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
},
|
|
{
|
|
"shareContext": [],
|
|
"shareToken": []
|
|
}
|
|
],
|
|
"summary": "Get websites charts",
|
|
"tags": [
|
|
"Websites"
|
|
],
|
|
"x-umami-audience": "public",
|
|
"x-umami-contract": "explicit",
|
|
"x-umami-source": "src/app/api/websites/charts/contract.generated.ts"
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "Account"
|
|
},
|
|
{
|
|
"name": "Administration"
|
|
},
|
|
{
|
|
"name": "Authentication"
|
|
},
|
|
{
|
|
"name": "Boards"
|
|
},
|
|
{
|
|
"name": "Collection"
|
|
},
|
|
{
|
|
"name": "Configuration"
|
|
},
|
|
{
|
|
"name": "Dashboard"
|
|
},
|
|
{
|
|
"name": "Links"
|
|
},
|
|
{
|
|
"name": "OAuth"
|
|
},
|
|
{
|
|
"name": "Pixels"
|
|
},
|
|
{
|
|
"name": "Realtime"
|
|
},
|
|
{
|
|
"name": "Reports"
|
|
},
|
|
{
|
|
"name": "Scripts"
|
|
},
|
|
{
|
|
"name": "Shares"
|
|
},
|
|
{
|
|
"name": "System"
|
|
},
|
|
{
|
|
"name": "Teams"
|
|
},
|
|
{
|
|
"name": "Two-factor authentication"
|
|
},
|
|
{
|
|
"name": "Users"
|
|
},
|
|
{
|
|
"name": "Websites"
|
|
}
|
|
]
|
|
}
|