Skip to content

Commit

Permalink
Upgrade api specification
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Nov 14, 2024
1 parent 041de24 commit 769bddb
Show file tree
Hide file tree
Showing 6 changed files with 453 additions and 453 deletions.
370 changes: 185 additions & 185 deletions packages/generator/spec.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,193 +141,9 @@
}
}
},
"/v2-experimental/apps/{app_id}/metrics": {
"get": {
"summary": "Get app metrics",
"description": "Returns a list of usage metrics for a specific app for a given time range, grouped by requested time period.\n\nThis endpoint requires an app management API token. It can be generated in the <a href=\"https://developers.miro.com/?features=appMetricsToken#your-apps\">Your Apps</a> section of Developer Hub. \n",
"operationId": "get-metrics",
"tags": ["app-management"],
"parameters": [
{
"in": "path",
"name": "app_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the app to get metrics for."
},
{
"in": "query",
"name": "startDate",
"required": true,
"schema": {
"type": "string",
"format": "date"
},
"description": "Start date of the period in UTC format. For example, 2024-12-31."
},
{
"in": "query",
"name": "endDate",
"required": true,
"schema": {
"type": "string",
"format": "date"
},
"description": "End date of the period in UTC format. For example, 2024-12-31."
},
{
"in": "query",
"name": "period",
"schema": {
"type": "string",
"enum": ["DAY", "WEEK", "MONTH"],
"default": "WEEK"
},
"description": "Group data by this time period."
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"periodStart": {
"type": "string",
"description": "Date from which the metrics are aggregated.",
"format": "date"
},
"uniqueUsers": {
"type": "integer",
"description": "Number of unique users who performed at least one activity in the application."
},
"uniqueRecurringUsers": {
"type": "integer",
"description": "Number of unique users who have been active for more than one day over the past 30 days."
},
"uniqueOrganizations": {
"type": "integer",
"description": "Number of unique company accounts that have installed the application."
},
"installations": {
"type": "integer",
"description": "Number of application installations for a team."
},
"uninstallations": {
"type": "integer",
"description": "Number of application uninstallations for a team."
}
}
}
}
}
}
},
"404": {
"description": "App not found response",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "App not found response",
"properties": {
"message": {
"type": "string"
},
"status": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"/v2-experimental/apps/{app_id}/metrics-total": {
"get": {
"summary": "Get total app metrics",
"description": "Returns total usage metrics for a specific app since the app was created.\n\nThis endpoint requires an app management API token. It can be generated in <a href=\"https://developers.miro.com/?features=appMetricsToken#your-apps\">your apps</a> section of Developer Hub. \n",
"operationId": "get-metrics-total",
"tags": ["app-management"],
"parameters": [
{
"in": "path",
"name": "app_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the app to get total metrics for."
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"uniqueUsers": {
"type": "integer",
"description": "Number of unique users who performed at least one activity in the application."
},
"uniqueRecurringUsers": {
"type": "integer",
"description": "Number of unique users who have been active for more than one day over the past 30 days."
},
"uniqueOrganizations": {
"type": "integer",
"description": "Number of unique company accounts that have installed the application."
},
"installations": {
"type": "integer",
"description": "Number of application installations for a team."
},
"uninstallations": {
"type": "integer",
"description": "Number of application uninstallations for a team."
}
}
}
}
}
},
"404": {
"description": "App not found response",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "App not found response",
"properties": {
"message": {
"type": "string",
"description": "Description of the error."
},
"status": {
"type": "integer",
"description": "HTTP status code."
}
}
}
}
}
}
}
}
},
"/v2/audit/logs": {
"get": {
"description": "Retrieves a page of audit events.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>auditlogs:read</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 2</a>",
"description": "Retrieves a page of audit events from the last 90 days. If you want to retrieve data that is older than 90 days, you can use the <a target=_blank href=\"https://help.miro.com/hc/en-us/articles/360017571434-Audit-logs#h_01J7EY4E0F67EFTRQ7BT688HW0\">CSV export feature</a>.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>auditlogs:read</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 2</a>",
"operationId": "enterprise-get-audit-logs",
"parameters": [
{
Expand Down Expand Up @@ -5036,6 +4852,190 @@
"tags": ["Bulk operations"]
}
},
"/v2-experimental/apps/{app_id}/metrics": {
"get": {
"summary": "Get app metrics",
"description": "Returns a list of usage metrics for a specific app for a given time range, grouped by requested time period.\n\nThis endpoint requires an app management API token. It can be generated in the <a href=\"https://developers.miro.com/?features=appMetricsToken#your-apps\">Your Apps</a> section of Developer Hub.<br/>\n<h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:read</a><br/>\n<h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 1</a><br/>\n",
"operationId": "get-metrics",
"tags": ["App metrics (experimental)"],
"parameters": [
{
"in": "path",
"name": "app_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the app to get metrics for."
},
{
"in": "query",
"name": "startDate",
"required": true,
"schema": {
"type": "string",
"format": "date"
},
"description": "Start date of the period in UTC format. For example, 2024-12-31."
},
{
"in": "query",
"name": "endDate",
"required": true,
"schema": {
"type": "string",
"format": "date"
},
"description": "End date of the period in UTC format. For example, 2024-12-31."
},
{
"in": "query",
"name": "period",
"schema": {
"type": "string",
"enum": ["DAY", "WEEK", "MONTH"],
"default": "WEEK"
},
"description": "Group data by this time period."
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"periodStart": {
"type": "string",
"description": "Date from which the metrics are aggregated.",
"format": "date"
},
"uniqueUsers": {
"type": "integer",
"description": "Number of unique users who performed at least one activity in the application."
},
"uniqueRecurringUsers": {
"type": "integer",
"description": "Number of unique users who have been active for more than one day over the past 30 days."
},
"uniqueOrganizations": {
"type": "integer",
"description": "Number of unique company accounts that have installed the application."
},
"installations": {
"type": "integer",
"description": "Number of application installations for a team."
},
"uninstallations": {
"type": "integer",
"description": "Number of application uninstallations for a team."
}
}
}
}
}
}
},
"404": {
"description": "App not found response",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "App not found response",
"properties": {
"message": {
"type": "string"
},
"status": {
"type": "integer"
}
}
}
}
}
}
}
}
},
"/v2-experimental/apps/{app_id}/metrics-total": {
"get": {
"summary": "Get total app metrics",
"description": "Returns total usage metrics for a specific app since the app was created.\n\nThis endpoint requires an app management API token. It can be generated in <a href=\"https://developers.miro.com/?features=appMetricsToken#your-apps\">your apps</a> section of Developer Hub.<br/>\n<h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:read</a><br/>\n<h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 1</a><br/>\n",
"operationId": "get-metrics-total",
"tags": ["App metrics (experimental)"],
"parameters": [
{
"in": "path",
"name": "app_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the app to get total metrics for."
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"uniqueUsers": {
"type": "integer",
"description": "Number of unique users who performed at least one activity in the application."
},
"uniqueRecurringUsers": {
"type": "integer",
"description": "Number of unique users who have been active for more than one day over the past 30 days."
},
"uniqueOrganizations": {
"type": "integer",
"description": "Number of unique company accounts that have installed the application."
},
"installations": {
"type": "integer",
"description": "Number of application installations for a team."
},
"uninstallations": {
"type": "integer",
"description": "Number of application uninstallations for a team."
}
}
}
}
}
},
"404": {
"description": "App not found response",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "App not found response",
"properties": {
"message": {
"type": "string",
"description": "Description of the error."
},
"status": {
"type": "integer",
"description": "HTTP status code."
}
}
}
}
}
}
}
}
},
"/v2-experimental/webhooks/board_subscriptions": {
"post": {
"description": "Creates a webhook subscription to receive notifications when an item on a board is updated. Subscriptions are created per user, per board. You can create multiple subscriptions. We currently support all board items except tags, connectors, and comments.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:read</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 2</a><br/>",
Expand Down
Loading

0 comments on commit 769bddb

Please sign in to comment.