From a6ba9ad7c805743312aa67849c29433ff2cad3ec Mon Sep 17 00:00:00 2001
From: Masahiro Iuchi
Date: Wed, 20 Aug 2025 22:46:57 +0900
Subject: [PATCH 1/5] Update src
---
src/openapi/v1.json | 473 +++++--
src/openapi/v1.yaml | 356 +++++-
src/openapi/v2.json | 1056 ++++++----------
src/openapi/v2.yaml | 532 ++++----
src/openapi/v3.json | 1056 ++++++----------
src/openapi/v3.yaml | 532 ++++----
src/openapi/v4.json | 1254 +++++++------------
src/openapi/v4.yaml | 628 +++++-----
src/openapi/v5.json | 1254 +++++++------------
src/openapi/v5.yaml | 628 +++++-----
src/openapi/v6.json | 1266 +++++++------------
src/openapi/v6.yaml | 640 +++++-----
src/openapi/v7.json | 2841 +++++++++++++++++++++++++++++--------------
src/openapi/v7.yaml | 1664 +++++++++++++++++++------
14 files changed, 7225 insertions(+), 6955 deletions(-)
diff --git a/src/openapi/v1.json b/src/openapi/v1.json
index 0a692e7..416b9ef 100644
--- a/src/openapi/v1.json
+++ b/src/openapi/v1.json
@@ -1,6 +1,95 @@
{
"components": {
"parameters": {
+ "category_excludeIds": {
+ "description": "The comma separated ID list of categories to exclude from result.",
+ "in": "query",
+ "name": "excludeIds",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "category_fields": {
+ "description": "The field list to retrieve as part of the category resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.",
+ "in": "query",
+ "name": "fields",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "category_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "category_includeIds": {
+ "description": "The comma separated ID list of categories to include to result.",
+ "in": "query",
+ "name": "includeIds",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "category_limit": {
+ "description": "Maximum number of categories to retrieve.\n\n**Default**: 10",
+ "in": "query",
+ "name": "limit",
+ "schema": {
+ "default": "10",
+ "type": "integer"
+ }
+ },
+ "category_offset": {
+ "description": "0-indexed offset.\n\n**Default**: 0",
+ "in": "query",
+ "name": "offset",
+ "schema": {
+ "default": "0",
+ "type": "integer"
+ }
+ },
+ "category_search": {
+ "description": "Search query.",
+ "in": "query",
+ "name": "search",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "category_searchFields": {
+ "description": "The comma separated field name list to search.\n\n**Default**: label,basename",
+ "in": "query",
+ "name": "searchFields",
+ "schema": {
+ "default": "label,basename",
+ "type": "string"
+ }
+ },
+ "category_sortBy": {
+ "description": "\n\n**Default**: user_custom",
+ "in": "query",
+ "name": "sortBy",
+ "schema": {
+ "default": "user_custom",
+ "type": "string"
+ }
+ },
+ "category_sortOrder": {
+ "description": "#### descend\n\nReturn categories in descending order.\n\n#### ascend\n\nReturn categories in ascending order.\n\n\n\n**Default**: ascend",
+ "in": "query",
+ "name": "sortOrder",
+ "schema": {
+ "default": "ascend",
+ "enum": [
+ "descend",
+ "ascend"
+ ],
+ "type": "string"
+ }
+ },
"comment_excludeIds": {
"description": "The comma separated ID list of comments to exclude from result.",
"in": "query",
@@ -17,6 +106,15 @@
"type": "string"
}
},
+ "comment_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"comment_includeIds": {
"description": "The comma separated ID list of comments to include to result.",
"in": "query",
@@ -98,6 +196,15 @@
"type": "string"
}
},
+ "entry_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"entry_includeIds": {
"description": "The comma separated ID list of entries to include to result.",
"in": "query",
@@ -152,6 +259,18 @@
"type": "integer"
}
},
+ "entry_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"entry_search": {
"description": "Search query.",
"in": "query",
@@ -213,6 +332,114 @@
"type": "string"
}
},
+ "field_filterKeys": {},
+ "field_searchFields": {},
+ "field_sortBy": {},
+ "field_sortOrder": {},
+ "permission_blogIds": {
+ "description": "The comma-separated blog id list that to be included in the result.",
+ "in": "query",
+ "name": "blogIds",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "permission_excludeIds": {
+ "description": "The comma separated ID list of permissions to exclude from result.",
+ "in": "query",
+ "name": "excludeIds",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "permission_fields": {
+ "description": "The field list to retrieve as part of the permission resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.",
+ "in": "query",
+ "name": "fields",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "permission_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: blogIds",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "blogIds",
+ "type": "string"
+ }
+ },
+ "permission_includeIds": {
+ "description": "The comma separated ID list of permissions to include to result.",
+ "in": "query",
+ "name": "includeIds",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "permission_limit": {
+ "description": "Maximum number of permissions to retrieve.\n\n**Default**: 25",
+ "in": "query",
+ "name": "limit",
+ "schema": {
+ "default": "25",
+ "type": "integer"
+ }
+ },
+ "permission_offset": {
+ "description": "0-indexed offset.\n\n**Default**: 0",
+ "in": "query",
+ "name": "offset",
+ "schema": {
+ "default": "0",
+ "type": "integer"
+ }
+ },
+ "permission_search": {
+ "description": "Search query.",
+ "in": "query",
+ "name": "search",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "permission_searchFields": {
+ "description": "The comma separated field name list to search.",
+ "in": "query",
+ "name": "searchFields",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "permission_sortBy": {
+ "description": "The field name for sort. You can specify one of following values\n\n- id\n- blog_id\n- author_id\n- created_by\n- created_on\n\n\n**Default**: blog_id",
+ "in": "query",
+ "name": "sortBy",
+ "schema": {
+ "default": "blog_id",
+ "enum": [
+ "id",
+ "blog_id",
+ "author_id",
+ "created_by",
+ "created_on"
+ ],
+ "type": "string"
+ }
+ },
+ "permission_sortOrder": {
+ "description": "#### descend\n\nReturn permissions in descending order.\n\n#### ascend\n\nReturn permissions in ascending order.\n\n\n\n**Default**: ascend",
+ "in": "query",
+ "name": "sortOrder",
+ "schema": {
+ "default": "ascend",
+ "enum": [
+ "descend",
+ "ascend"
+ ],
+ "type": "string"
+ }
+ },
"site_excludeIds": {
"description": "The comma separated ID list of sites to exclude from result.",
"in": "query",
@@ -229,6 +456,14 @@
"type": "string"
}
},
+ "site_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"site_includeIds": {
"description": "The comma separated ID list of sites to include to result.",
"in": "query",
@@ -981,7 +1216,7 @@
},
"info": {
"title": "Movable Type Data API",
- "version": "8.6.0"
+ "version": "8.7.0"
},
"openapi": "3.0.0",
"paths": {
@@ -1425,11 +1660,6 @@
"description": "Do not have permission to publish."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rebuild the static archives in relation to specified entries",
"tags": [
"Entries",
@@ -1640,11 +1870,6 @@
"description": "Conflict"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Upload a file",
"tags": [
"Assets"
@@ -1686,6 +1911,15 @@
],
"type": "string"
}
+ },
+ {
+ "$ref": "#/components/parameters/category_limit"
+ },
+ {
+ "$ref": "#/components/parameters/category_offset"
+ },
+ {
+ "$ref": "#/components/parameters/category_searchFields"
}
],
"responses": {
@@ -1830,6 +2064,50 @@
],
"type": "string"
}
+ },
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
+ {
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status,entryStatus",
+ "type": "string"
+ }
+ },
+ {
+ "in": "query",
+ "name": "searchFields",
+ "schema": {
+ "default": "body",
+ "type": "string"
+ }
+ },
+ {
+ "in": "query",
+ "name": "sortBy",
+ "schema": {
+ "default": "id",
+ "type": "string"
+ }
+ },
+ {
+ "in": "query",
+ "name": "sortOrder",
+ "schema": {
+ "default": "descend",
+ "type": "string"
+ }
}
],
"responses": {
@@ -1972,11 +2250,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a comment",
"tags": [
"Comments"
@@ -2149,11 +2422,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a comment",
"tags": [
"Comments"
@@ -2293,6 +2561,9 @@
"schema": {
"type": "string"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
}
],
"responses": {
@@ -2368,6 +2639,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_saveRevision"
}
],
"requestBody": {
@@ -2429,11 +2703,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new entry",
"tags": [
"Entries"
@@ -2516,11 +2785,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an entry",
"tags": [
"Entries"
@@ -2646,6 +2910,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_saveRevision"
}
],
"requestBody": {
@@ -2717,11 +2984,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an entry",
"tags": [
"Entries"
@@ -2771,6 +3033,50 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
+ {
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
+ {
+ "in": "query",
+ "name": "searchFields",
+ "schema": {
+ "default": "body",
+ "type": "string"
+ }
+ },
+ {
+ "in": "query",
+ "name": "sortBy",
+ "schema": {
+ "default": "id",
+ "type": "string"
+ }
+ },
+ {
+ "in": "query",
+ "name": "sortOrder",
+ "schema": {
+ "default": "descend",
+ "type": "string"
+ }
}
],
"responses": {
@@ -2916,11 +3222,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new comment on an entry",
"tags": [
"Comments",
@@ -3016,11 +3317,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reply to specified comment",
"tags": [
"Comments",
@@ -3041,7 +3337,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -3051,7 +3347,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -3085,7 +3381,7 @@
}
},
{
- "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
"in": "query",
"name": "uniquePath",
"schema": {
@@ -3161,11 +3457,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve pageviews count for each date from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -3185,7 +3476,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -3195,7 +3486,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -3293,11 +3584,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve visits count for each date from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -3317,7 +3603,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -3327,7 +3613,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -3361,7 +3647,7 @@
}
},
{
- "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
"in": "query",
"name": "uniquePath",
"schema": {
@@ -3437,11 +3723,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve pageviews count for each path from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -3461,7 +3742,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -3471,7 +3752,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -3569,11 +3850,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve visits count for each path from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -3640,11 +3916,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a current effective provider",
"tags": [
"Statistics"
@@ -3702,11 +3973,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Invalidate current session. This is like logout",
"tags": [
"Authentication"
@@ -3829,11 +4095,6 @@
"description": "Do not have permission to synchronize users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Synchronize users",
"tags": [
"Users"
@@ -4000,11 +4261,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update user data",
"tags": [
"Users"
@@ -4030,6 +4286,21 @@
"schema": {
"type": "string"
}
+ },
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/permission_limit"
+ },
+ {
+ "$ref": "#/components/parameters/permission_offset"
+ },
+ {
+ "$ref": "#/components/parameters/permission_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/permission_sortOrder"
}
],
"responses": {
@@ -4089,11 +4360,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for a user",
"tags": [
"Users",
@@ -4294,6 +4560,11 @@
}
}
},
+ "security": [
+ {
+ "mtauth": []
+ }
+ ],
"servers": [
{
"url": "https://example.com/mt/mt-data-api.cgi/v1"
diff --git a/src/openapi/v1.yaml b/src/openapi/v1.yaml
index f614b56..7ca8c0d 100644
--- a/src/openapi/v1.yaml
+++ b/src/openapi/v1.yaml
@@ -1,6 +1,94 @@
---
components:
parameters:
+ category_excludeIds:
+ description: The comma separated ID list of categories to exclude from result.
+ in: query
+ name: excludeIds
+ schema:
+ type: string
+ category_fields:
+ description: 'The field list to retrieve as part of the category resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.'
+ in: query
+ name: fields
+ schema:
+ type: string
+ category_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
+ category_includeIds:
+ description: The comma separated ID list of categories to include to result.
+ in: query
+ name: includeIds
+ schema:
+ type: string
+ category_limit:
+ description: |-
+ Maximum number of categories to retrieve.
+
+ **Default**: 10
+ in: query
+ name: limit
+ schema:
+ default: 10
+ type: integer
+ category_offset:
+ description: |-
+ 0-indexed offset.
+
+ **Default**: 0
+ in: query
+ name: offset
+ schema:
+ default: 0
+ type: integer
+ category_search:
+ description: Search query.
+ in: query
+ name: search
+ schema:
+ type: string
+ category_searchFields:
+ description: |-
+ The comma separated field name list to search.
+
+ **Default**: label,basename
+ in: query
+ name: searchFields
+ schema:
+ default: 'label,basename'
+ type: string
+ category_sortBy:
+ description: "\n\n**Default**: user_custom"
+ in: query
+ name: sortBy
+ schema:
+ default: user_custom
+ type: string
+ category_sortOrder:
+ description: |-
+ #### descend
+
+ Return categories in descending order.
+
+ #### ascend
+
+ Return categories in ascending order.
+
+
+
+ **Default**: ascend
+ in: query
+ name: sortOrder
+ schema:
+ default: ascend
+ enum:
+ - descend
+ - ascend
+ type: string
comment_excludeIds:
description: The comma separated ID list of comments to exclude from result.
in: query
@@ -13,6 +101,16 @@ components:
name: fields
schema:
type: string
+ comment_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
comment_includeIds:
description: The comma separated ID list of comments to include to result.
in: query
@@ -95,6 +193,16 @@ components:
name: fields
schema:
type: string
+ entry_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
entry_includeIds:
description: The comma separated ID list of entries to include to result.
in: query
@@ -142,6 +250,15 @@ components:
schema:
default: 0
type: integer
+ entry_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
entry_search:
description: Search query.
in: query
@@ -237,6 +354,120 @@ components:
- Spam
- Unpublish
type: string
+ field_filterKeys: {}
+ field_searchFields: {}
+ field_sortBy: {}
+ field_sortOrder: {}
+ permission_blogIds:
+ description: The comma-separated blog id list that to be included in the result.
+ in: query
+ name: blogIds
+ schema:
+ type: string
+ permission_excludeIds:
+ description: The comma separated ID list of permissions to exclude from result.
+ in: query
+ name: excludeIds
+ schema:
+ type: string
+ permission_fields:
+ description: 'The field list to retrieve as part of the permission resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.'
+ in: query
+ name: fields
+ schema:
+ type: string
+ permission_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: blogIds
+ in: query
+ name: filterKeys
+ schema:
+ default: blogIds
+ type: string
+ permission_includeIds:
+ description: The comma separated ID list of permissions to include to result.
+ in: query
+ name: includeIds
+ schema:
+ type: string
+ permission_limit:
+ description: |-
+ Maximum number of permissions to retrieve.
+
+ **Default**: 25
+ in: query
+ name: limit
+ schema:
+ default: 25
+ type: integer
+ permission_offset:
+ description: |-
+ 0-indexed offset.
+
+ **Default**: 0
+ in: query
+ name: offset
+ schema:
+ default: 0
+ type: integer
+ permission_search:
+ description: Search query.
+ in: query
+ name: search
+ schema:
+ type: string
+ permission_searchFields:
+ description: The comma separated field name list to search.
+ in: query
+ name: searchFields
+ schema:
+ type: string
+ permission_sortBy:
+ description: |-
+ The field name for sort. You can specify one of following values
+
+ - id
+ - blog_id
+ - author_id
+ - created_by
+ - created_on
+
+
+ **Default**: blog_id
+ in: query
+ name: sortBy
+ schema:
+ default: blog_id
+ enum:
+ - id
+ - blog_id
+ - author_id
+ - created_by
+ - created_on
+ type: string
+ permission_sortOrder:
+ description: |-
+ #### descend
+
+ Return permissions in descending order.
+
+ #### ascend
+
+ Return permissions in ascending order.
+
+
+
+ **Default**: ascend
+ in: query
+ name: sortOrder
+ schema:
+ default: ascend
+ enum:
+ - descend
+ - ascend
+ type: string
site_excludeIds:
description: The comma separated ID list of sites to exclude from result.
in: query
@@ -249,6 +480,12 @@ components:
name: fields
schema:
type: string
+ site_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
site_includeIds:
description: The comma separated ID list of sites to include to result.
in: query
@@ -775,7 +1012,7 @@ externalDocs:
url: https://www.movabletype.jp/developers/data-api/
info:
title: Movable Type Data API
- version: 8.6.0
+ version: 8.7.0
openapi: 3.0.0
paths:
/:
@@ -1083,8 +1320,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to publish.
- security:
- - mtauth: []
summary: Rebuild the static archives in relation to specified entries
tags:
- Entries
@@ -1220,8 +1455,6 @@ paths:
type: object
type: object
description: Conflict
- security:
- - mtauth: []
summary: Upload a file
tags:
- Assets
@@ -1268,6 +1501,9 @@ paths:
- ascend
- descend
type: string
+ - $ref: '#/components/parameters/category_limit'
+ - $ref: '#/components/parameters/category_offset'
+ - $ref: '#/components/parameters/category_searchFields'
responses:
200:
content:
@@ -1381,6 +1617,30 @@ paths:
- Future
- Spam
type: string
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
+ - in: query
+ name: filterKeys
+ schema:
+ default: 'status,entryStatus'
+ type: string
+ - in: query
+ name: searchFields
+ schema:
+ default: body
+ type: string
+ - in: query
+ name: sortBy
+ schema:
+ default: id
+ type: string
+ - in: query
+ name: sortOrder
+ schema:
+ default: descend
+ type: string
responses:
200:
content:
@@ -1473,8 +1733,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a comment
tags:
- Comments
@@ -1589,8 +1847,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a comment
tags:
- Comments
@@ -1737,6 +1993,7 @@ paths:
name: fields
schema:
type: string
+ - $ref: '#/components/parameters/entry_filterKeys'
responses:
200:
content:
@@ -1787,6 +2044,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/entry_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -1822,8 +2080,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Create a new entry
tags:
- Entries
@@ -1881,8 +2137,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an entry
tags:
- Entries
@@ -1972,6 +2226,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/entry_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -2013,8 +2268,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an entry
tags:
- Entries
@@ -2050,6 +2303,30 @@ paths:
name: offset
schema:
type: integer
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
+ - in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
+ - in: query
+ name: searchFields
+ schema:
+ default: body
+ type: string
+ - in: query
+ name: sortBy
+ schema:
+ default: id
+ type: string
+ - in: query
+ name: sortOrder
+ schema:
+ default: descend
+ type: string
responses:
200:
content:
@@ -2141,8 +2418,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Create a new comment on an entry
tags:
- Comments
@@ -2204,8 +2479,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Reply to specified comment
tags:
- Comments
@@ -2222,14 +2495,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -2251,7 +2524,7 @@ paths:
name: path
schema:
type: string
- - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
+ - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
in: query
name: uniquePath
schema:
@@ -2299,8 +2572,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve pageviews count for each date from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -2316,14 +2587,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -2385,8 +2656,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve visits count for each date from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -2402,14 +2671,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -2431,7 +2700,7 @@ paths:
name: path
schema:
type: string
- - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
+ - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
in: query
name: uniquePath
schema:
@@ -2479,8 +2748,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve pageviews count for each path from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -2496,14 +2763,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -2565,8 +2832,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve visits count for each path from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -2610,8 +2875,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve a current effective provider
tags:
- Statistics
@@ -2653,8 +2916,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Invalidate current session. This is like logout
tags:
- Authentication
@@ -2737,8 +2998,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to synchronize users.
- security:
- - mtauth: []
summary: Synchronize users
tags:
- Users
@@ -2849,8 +3108,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update user data
tags:
- Users
@@ -2871,6 +3128,11 @@ paths:
name: blogIds
schema:
type: string
+ - $ref: '#/components/parameters/permission_filterKeys'
+ - $ref: '#/components/parameters/permission_limit'
+ - $ref: '#/components/parameters/permission_offset'
+ - $ref: '#/components/parameters/permission_sortBy'
+ - $ref: '#/components/parameters/permission_sortOrder'
responses:
200:
content:
@@ -2906,8 +3168,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve a list of permissions for a user
tags:
- Users
@@ -3057,6 +3317,8 @@ paths:
summary: Get server API version
tags:
- Common API
+security:
+ - mtauth: []
servers:
- url: https://example.com/mt/mt-data-api.cgi/v1
tags:
diff --git a/src/openapi/v2.json b/src/openapi/v2.json
index c8144c6..8d86fe1 100644
--- a/src/openapi/v2.json
+++ b/src/openapi/v2.json
@@ -17,6 +17,15 @@
"type": "string"
}
},
+ "asset_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: class",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "class",
+ "type": "string"
+ }
+ },
"asset_includeIds": {
"description": "The comma separated ID list of assets to include to result.",
"in": "query",
@@ -98,6 +107,14 @@
"type": "string"
}
},
+ "category_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"category_includeIds": {
"description": "The comma separated ID list of categories to include to result.",
"in": "query",
@@ -179,6 +196,15 @@
"type": "string"
}
},
+ "comment_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"comment_includeIds": {
"description": "The comma separated ID list of comments to include to result.",
"in": "query",
@@ -260,6 +286,15 @@
"type": "string"
}
},
+ "entry_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"entry_includeIds": {
"description": "The comma separated ID list of entries to include to result.",
"in": "query",
@@ -314,6 +349,18 @@
"type": "integer"
}
},
+ "entry_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"entry_search": {
"description": "Search query.",
"in": "query",
@@ -391,6 +438,15 @@
"type": "string"
}
},
+ "field_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: systemObject,type",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "systemObject,type",
+ "type": "string"
+ }
+ },
"field_includeIds": {
"description": "The comma separated ID list of fields to include to result.",
"in": "query",
@@ -472,6 +528,14 @@
"type": "string"
}
},
+ "folder_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"folder_includeIds": {
"description": "The comma separated ID list of folders to include to result.",
"in": "query",
@@ -553,6 +617,14 @@
"type": "string"
}
},
+ "formatted_text_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"formatted_text_includeIds": {
"description": "The comma separated ID list of formatted_texts to include to result.",
"in": "query",
@@ -634,6 +706,15 @@
"type": "string"
}
},
+ "group_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"group_includeIds": {
"description": "The comma separated ID list of groups to include to result.",
"in": "query",
@@ -715,6 +796,15 @@
"type": "string"
}
},
+ "log_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: level",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "level",
+ "type": "string"
+ }
+ },
"log_includeIds": {
"description": "The comma separated ID list of logs to include to result.",
"in": "query",
@@ -796,6 +886,15 @@
"type": "string"
}
},
+ "page_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"page_includeIds": {
"description": "The comma separated ID list of pages to include to result.",
"in": "query",
@@ -850,6 +949,18 @@
"type": "integer"
}
},
+ "page_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"page_search": {
"description": "Search query.",
"in": "query",
@@ -935,6 +1046,15 @@
"type": "string"
}
},
+ "permission_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: blogIds",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "blogIds",
+ "type": "string"
+ }
+ },
"permission_includeIds": {
"description": "The comma separated ID list of permissions to include to result.",
"in": "query",
@@ -1022,6 +1142,14 @@
"type": "string"
}
},
+ "role_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"role_includeIds": {
"description": "The comma separated ID list of roles to include to result.",
"in": "query",
@@ -1110,6 +1238,14 @@
"type": "string"
}
},
+ "site_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"site_includeIds": {
"description": "The comma separated ID list of sites to include to result.",
"in": "query",
@@ -1194,6 +1330,14 @@
"type": "string"
}
},
+ "tag_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"tag_includeIds": {
"description": "The comma separated ID list of tags to include to result.",
"in": "query",
@@ -1275,6 +1419,15 @@
"type": "string"
}
},
+ "template_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: type",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "type",
+ "type": "string"
+ }
+ },
"template_includeIds": {
"description": "The comma separated ID list of templates to include to result.",
"in": "query",
@@ -1301,6 +1454,18 @@
"type": "integer"
}
},
+ "template_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"template_search": {
"description": "Search query.",
"in": "query",
@@ -1356,6 +1521,15 @@
"type": "string"
}
},
+ "templatemap_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: archiveType,buildType,isPreferred",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "archiveType,buildType,isPreferred",
+ "type": "string"
+ }
+ },
"templatemap_includeIds": {
"description": "The comma separated ID list of templatemaps to include to result.",
"in": "query",
@@ -1436,6 +1610,15 @@
"type": "string"
}
},
+ "user_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status,lockout",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status,lockout",
+ "type": "string"
+ }
+ },
"user_includeIds": {
"description": "The comma separated ID list of users to include to result.",
"in": "query",
@@ -1517,6 +1700,14 @@
"type": "string"
}
},
+ "widget_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"widget_includeIds": {
"description": "The comma separated ID list of widgets to include to result.",
"in": "query",
@@ -1598,6 +1789,14 @@
"type": "string"
}
},
+ "widgetset_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"widgetset_includeIds": {
"description": "The comma separated ID list of widgetsets to include to result.",
"in": "query",
@@ -4702,7 +4901,7 @@
},
"info": {
"title": "Movable Type Data API",
- "version": "8.6.0"
+ "version": "8.7.0"
},
"openapi": "3.0.0",
"paths": {
@@ -4898,11 +5097,6 @@
"description": "Upload file size is larger than CGIMaxUpload."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Upload a file",
"tags": [
"Assets"
@@ -5241,6 +5435,9 @@
},
{
"$ref": "#/components/parameters/group_fields"
+ },
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
}
],
"responses": {
@@ -5291,11 +5488,6 @@
"description": "Do not have permission to retrieve the requested groups."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of groups",
"tags": [
"Groups"
@@ -5351,11 +5543,6 @@
"description": "Do not have permission to create a group."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new group",
"tags": [
"Groups"
@@ -5404,11 +5591,6 @@
"description": "Do not have permission to synchronize groups."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Synchronize groups",
"tags": [
"Groups"
@@ -5483,11 +5665,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a group",
"tags": [
"Groups"
@@ -5552,11 +5729,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single group by its ID",
"tags": [
"Groups"
@@ -5643,11 +5815,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a group",
"tags": [
"Groups"
@@ -5685,6 +5852,9 @@
},
{
"$ref": "#/components/parameters/group_fields"
+ },
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
}
],
"responses": {
@@ -5745,11 +5915,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of members for specified group",
"tags": [
"Groups"
@@ -5830,11 +5995,6 @@
"description": "Group or Member not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"tags": [
"Groups"
]
@@ -5916,11 +6076,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"tags": [
"Groups"
]
@@ -5992,11 +6147,6 @@
"description": "Group or Member not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single member by its ID for specified group",
"tags": [
"Groups"
@@ -6032,6 +6182,9 @@
},
{
"$ref": "#/components/parameters/permission_blogIds"
+ },
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
}
],
"responses": {
@@ -6092,11 +6245,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for group",
"tags": [
"Groups",
@@ -6186,11 +6334,6 @@
"description": "Site or Group not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to group",
"tags": [
"Groups",
@@ -6280,11 +6423,6 @@
"description": "Site or Group not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from group",
"tags": [
"Groups",
@@ -6313,6 +6451,9 @@
},
{
"$ref": "#/components/parameters/permission_blogIds"
+ },
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
}
],
"responses": {
@@ -6373,11 +6514,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions",
"tags": [
"Permissions"
@@ -6444,11 +6580,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of plugins in the specified site",
"tags": [
"Plugins"
@@ -6507,11 +6638,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Disable all plugins",
"tags": [
"Plugins"
@@ -6570,11 +6696,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Enable all plugins",
"tags": [
"Plugins"
@@ -6638,11 +6759,6 @@
"description": "Site or Plugin not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single plugin by its ID",
"tags": [
"Plugins"
@@ -6711,11 +6827,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Disable a plugin",
"tags": [
"Plugins"
@@ -6784,11 +6895,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Enable a plugin",
"tags": [
"Plugins"
@@ -6886,11 +6992,6 @@
"description": "Do not have permission to publish."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rebuild the static archives in relation to specified entries",
"tags": [
"Entries",
@@ -7049,11 +7150,6 @@
"description": "Do not have permission to retrieve the list of roles."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of roles",
"tags": [
"Roles"
@@ -7119,11 +7215,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new role",
"tags": [
"Roles"
@@ -7198,11 +7289,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing role",
"tags": [
"Roles"
@@ -7267,11 +7353,6 @@
"description": "Site or Role not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single role by its ID",
"tags": [
"Roles"
@@ -7358,11 +7439,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing role",
"tags": [
"Roles"
@@ -7398,6 +7474,9 @@
},
{
"$ref": "#/components/parameters/permission_blogIds"
+ },
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
}
],
"responses": {
@@ -7458,11 +7537,6 @@
"description": "Site or Role not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions by role",
"tags": [
"Roles",
@@ -7771,11 +7845,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new website",
"tags": [
"Sites"
@@ -7850,11 +7919,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing blog or website",
"tags": [
"Sites"
@@ -8008,11 +8072,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new blog",
"tags": [
"Sites"
@@ -8099,11 +8158,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing blog or website",
"tags": [
"Sites"
@@ -8141,6 +8195,9 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -8377,11 +8434,6 @@
"description": "Conflict"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Upload a file",
"tags": [
"Assets"
@@ -8464,11 +8516,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an asset",
"tags": [
"Assets"
@@ -8643,11 +8690,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an asset",
"tags": [
"Assets"
@@ -8720,6 +8762,9 @@
},
{
"$ref": "#/components/parameters/entry_no_text_filter"
+ },
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
}
],
"responses": {
@@ -8853,6 +8898,9 @@
},
{
"$ref": "#/components/parameters/page_no_text_filter"
+ },
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
}
],
"responses": {
@@ -9107,11 +9155,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Backup specified site",
"tags": [
"Sites",
@@ -9324,11 +9367,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new category",
"tags": [
"Categories"
@@ -9412,11 +9450,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rearrange existing categories in a new order",
"tags": [
"Categories"
@@ -9499,11 +9532,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing category",
"tags": [
"Categories"
@@ -9678,11 +9706,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing category",
"tags": [
"Categories"
@@ -9866,6 +9889,9 @@
},
{
"$ref": "#/components/parameters/entry_no_text_filter"
+ },
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
}
],
"responses": {
@@ -10377,6 +10403,18 @@
],
"type": "string"
}
+ },
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
}
],
"responses": {
@@ -10519,11 +10557,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a comment",
"tags": [
"Comments"
@@ -10696,11 +10729,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a comment",
"tags": [
"Comments"
@@ -10840,6 +10868,9 @@
"schema": {
"type": "string"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
}
],
"responses": {
@@ -10915,6 +10946,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_saveRevision"
}
],
"requestBody": {
@@ -10976,11 +11010,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new entry",
"tags": [
"Entries"
@@ -11044,11 +11073,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export entries",
"tags": [
"Entries"
@@ -11164,11 +11188,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Import entries",
"tags": [
"Entries"
@@ -11268,11 +11287,6 @@
"description": "Site or Entry not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a entry",
"tags": [
"Entries"
@@ -11355,11 +11369,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an entry",
"tags": [
"Entries"
@@ -11485,6 +11494,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_saveRevision"
}
],
"requestBody": {
@@ -11556,11 +11568,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an entry",
"tags": [
"Entries"
@@ -11627,6 +11634,12 @@
},
{
"$ref": "#/components/parameters/asset_fields"
+ },
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
}
],
"responses": {
@@ -11891,6 +11904,18 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
}
],
"responses": {
@@ -12036,11 +12061,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new comment on an entry",
"tags": [
"Comments",
@@ -12136,11 +12156,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reply to specified comment",
"tags": [
"Comments",
@@ -12249,11 +12264,6 @@
"description": "Site or Entry not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a entry with existing data",
"tags": [
"Entries"
@@ -12323,11 +12333,6 @@
"description": "Site or Theme not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export site's theme",
"tags": [
"Themes"
@@ -12365,6 +12370,9 @@
},
{
"$ref": "#/components/parameters/field_fields"
+ },
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
}
],
"responses": {
@@ -12425,11 +12433,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of fields in the specified site",
"tags": [
"CustomFields"
@@ -12505,11 +12508,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new field",
"tags": [
"CustomFields"
@@ -12592,11 +12590,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a field",
"tags": [
"CustomFields"
@@ -12669,11 +12662,6 @@
"description": "Site or Field not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single field by its ID",
"tags": [
"CustomFields"
@@ -12768,11 +12756,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a field",
"tags": [
"CustomFields"
@@ -12975,11 +12958,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new folder.",
"tags": [
"Folders"
@@ -13063,11 +13041,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rearrange existing folders in a new order",
"tags": [
"Folders"
@@ -13150,11 +13123,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing folder",
"tags": [
"Folders"
@@ -13329,11 +13297,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing folder",
"tags": [
"Folders"
@@ -13508,6 +13471,9 @@
},
{
"$ref": "#/components/parameters/page_no_text_filter"
+ },
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
}
],
"responses": {
@@ -13908,11 +13874,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of formatted_texts in the specified site",
"tags": [
"FormattedText"
@@ -13988,11 +13949,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new formatted_text",
"tags": [
"FormattedText"
@@ -14075,11 +14031,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a formatted_text",
"tags": [
"FormattedText"
@@ -14152,11 +14103,6 @@
"description": "Site or FormattedText not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single formatted_text by its ID",
"tags": [
"FormattedText"
@@ -14251,11 +14197,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a formatted_text",
"tags": [
"FormattedText"
@@ -14335,11 +14276,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset logs",
"tags": [
"Logs"
@@ -14368,6 +14304,9 @@
{
"$ref": "#/components/parameters/log_offset"
},
+ {
+ "$ref": "#/components/parameters/log_filterKeys"
+ },
{
"description": "- id\n- created_on\n- blog_id\n- author_id\n- level\n- class\n\n**Default**: created_on\n",
"in": "query",
@@ -14475,11 +14414,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of logs in the specified site",
"tags": [
"Logs"
@@ -14555,11 +14489,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new log",
"tags": [
"Logs"
@@ -14630,11 +14559,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export logs",
"tags": [
"Logs"
@@ -14717,11 +14641,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing log",
"tags": [
"Logs"
@@ -14794,11 +14713,6 @@
"description": "Site or Log not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single log by its ID",
"tags": [
"Logs"
@@ -14893,11 +14807,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing log",
"tags": [
"Logs"
@@ -14962,6 +14871,9 @@
},
{
"$ref": "#/components/parameters/page_no_text_filter"
+ },
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
}
],
"responses": {
@@ -15037,6 +14949,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/page_saveRevision"
}
],
"requestBody": {
@@ -15098,11 +15013,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new page",
"tags": [
"Pages"
@@ -15202,11 +15112,6 @@
"description": "Site or Page not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a page",
"tags": [
"Pages"
@@ -15289,11 +15194,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing page",
"tags": [
"Pages"
@@ -15398,6 +15298,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/page_saveRevision"
}
],
"requestBody": {
@@ -15469,11 +15372,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing page",
"tags": [
"Pages"
@@ -15513,6 +15411,12 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -15648,6 +15552,18 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
}
],
"responses": {
@@ -15793,11 +15709,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new comment on a page",
"tags": [
"Comments",
@@ -15893,11 +15804,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reply to specified comment",
"tags": [
"Comments",
@@ -16006,11 +15912,6 @@
"description": "Site or Page not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a page with existing data",
"tags": [
"Pages"
@@ -16103,11 +16004,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for site",
"tags": [
"Sites",
@@ -16197,11 +16093,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to site",
"tags": [
"Sites",
@@ -16291,11 +16182,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from site",
"tags": [
"Sites",
@@ -16379,11 +16265,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset all templates in the site",
"tags": [
"Templates"
@@ -16403,7 +16284,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -16413,7 +16294,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -16447,7 +16328,7 @@
}
},
{
- "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
"in": "query",
"name": "uniquePath",
"schema": {
@@ -16523,11 +16404,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve pageviews count for each date from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -16547,7 +16423,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -16557,7 +16433,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -16655,11 +16531,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve visits count for each date from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -16679,7 +16550,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -16689,7 +16560,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -16723,7 +16594,7 @@
}
},
{
- "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
"in": "query",
"name": "uniquePath",
"schema": {
@@ -16799,11 +16670,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve pageviews count for each path from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -16823,7 +16689,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -16833,7 +16699,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -16931,11 +16797,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve visits count for each path from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -17002,11 +16863,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a current effective provider",
"tags": [
"Statistics"
@@ -17186,11 +17042,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing tag",
"tags": [
"Tags"
@@ -17357,11 +17208,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing tag",
"tags": [
"Tags"
@@ -17401,6 +17247,12 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -17559,6 +17411,9 @@
},
{
"$ref": "#/components/parameters/entry_no_text_filter"
+ },
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
}
],
"responses": {
@@ -17692,6 +17547,9 @@
},
{
"$ref": "#/components/parameters/page_no_text_filter"
+ },
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
}
],
"responses": {
@@ -17783,6 +17641,9 @@
{
"$ref": "#/components/parameters/template_offset"
},
+ {
+ "$ref": "#/components/parameters/template_filterKeys"
+ },
{
"description": "#### id\n\nSort by the ID of each template.\n\n#### name\n\nSort by the name of each template.\n\n#### created_on\n\nSort by the created time of each template.\n\n#### modified_on\n\nSort by the modified time of each template.\n\n#### created_by\n\nSort by the ID of user who created each template.\n\n#### modified_by\n\nSort by the ID of user who modified each template.\n\n#### type\n\nSort by the type of each template.\n\n**Default**: name\n",
"in": "query",
@@ -17880,11 +17741,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of templates in the specified site",
"tags": [
"Templates"
@@ -17900,6 +17756,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/template_saveRevision"
}
],
"requestBody": {
@@ -17961,11 +17820,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new template",
"tags": [
"Templates"
@@ -18065,11 +17919,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a template",
"tags": [
"Templates"
@@ -18152,11 +18001,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a template",
"tags": [
"Templates"
@@ -18230,11 +18074,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single template by its ID",
"tags": [
"Templates"
@@ -18258,6 +18097,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/template_saveRevision"
}
],
"requestBody": {
@@ -18329,11 +18171,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a template",
"tags": [
"Templates"
@@ -18411,11 +18248,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a clone of a template",
"tags": [
"Templates"
@@ -18523,11 +18355,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a template with existing data",
"tags": [
"Templates"
@@ -18605,11 +18432,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Publish a template",
"tags": [
"Templates"
@@ -18693,11 +18515,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset template text to theme default or tempalte_set default",
"tags": [
"Templates"
@@ -18749,6 +18566,9 @@
},
{
"$ref": "#/components/parameters/templatemap_excludeIds"
+ },
+ {
+ "$ref": "#/components/parameters/templatemap_filterKeys"
}
],
"responses": {
@@ -18809,11 +18629,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of templatemaps in the specified site",
"tags": [
"Templates",
@@ -18898,11 +18713,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new templatemap",
"tags": [
"Templates",
@@ -18994,11 +18804,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing templatemap",
"tags": [
"Templates",
@@ -19077,11 +18882,6 @@
"description": "Site or Template or TemplateMap not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single templatemap by its ID",
"tags": [
"Templates",
@@ -19185,11 +18985,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing templatemap",
"tags": [
"Templates",
@@ -19268,11 +19063,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of themes for site",
"tags": [
"Themes"
@@ -19345,11 +19135,6 @@
"description": "Site or Theme not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single theme by its ID for site",
"tags": [
"Themes"
@@ -19427,11 +19212,6 @@
"description": "Site or Theme not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Apply a theme to site",
"tags": [
"Themes"
@@ -19535,11 +19315,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgets in the specified site",
"tags": [
"Widgets"
@@ -19615,11 +19390,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new widget",
"tags": [
"Widgets"
@@ -19702,11 +19472,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a widget",
"tags": [
"Widgets"
@@ -19779,11 +19544,6 @@
"description": "Site or Widget not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widget by its ID",
"tags": [
"Widgets"
@@ -19878,11 +19638,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a widget",
"tags": [
"Widgets"
@@ -19959,11 +19714,6 @@
"description": "Site or Widget not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a clone of a widget",
"tags": [
"Widgets"
@@ -20046,11 +19796,6 @@
"description": "Site or Widget not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset widget text to default",
"tags": [
"Widgets"
@@ -20154,11 +19899,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgetsets in the specified site",
"tags": [
"WidgetSets"
@@ -20234,11 +19974,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new widgetset",
"tags": [
"WidgetSets"
@@ -20321,11 +20056,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing widgetset",
"tags": [
"WidgetSets"
@@ -20398,11 +20128,6 @@
"description": "Site or WidgetSet not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widgetset by its ID",
"tags": [
"WidgetSets"
@@ -20497,11 +20222,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing widgetset",
"tags": [
"WidgetSets"
@@ -20613,11 +20333,6 @@
"description": "Site or WidgetSet not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgets in the specified widgetset",
"tags": [
"Widgets",
@@ -20701,11 +20416,6 @@
"description": "Site or Widget not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widget by widgetset ID",
"tags": [
"Widgets",
@@ -20774,11 +20484,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of themes",
"tags": [
"Themes"
@@ -20853,11 +20558,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Uninstall a specified theme from the MT",
"tags": [
"Themes"
@@ -20920,11 +20620,6 @@
"description": "Site or Theme not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single theme by its ID",
"tags": [
"Themes"
@@ -20982,11 +20677,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Invalidate current session. This is like logout",
"tags": [
"Authentication"
@@ -21091,6 +20781,9 @@
{
"$ref": "#/components/parameters/user_offset"
},
+ {
+ "$ref": "#/components/parameters/user_filterKeys"
+ },
{
"description": "The field name for sort. You can specify one of following values\n- id\n- name\n\n**Default**: name\n",
"in": "query",
@@ -21266,11 +20959,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new user",
"tags": [
"Users"
@@ -21314,11 +21002,6 @@
"description": "Do not have permission to export users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export users",
"tags": [
"Users"
@@ -21391,11 +21074,6 @@
"description": "Do not have permission to import users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Import users",
"tags": [
"Users"
@@ -21444,11 +21122,6 @@
"description": "Do not have permission to synchronize users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Synchronize users",
"tags": [
"Users"
@@ -21523,11 +21196,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete user",
"tags": [
"Users"
@@ -21692,11 +21360,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update user data",
"tags": [
"Users"
@@ -21734,6 +21397,9 @@
},
{
"$ref": "#/components/parameters/group_fields"
+ },
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
}
],
"responses": {
@@ -21794,11 +21460,6 @@
"description": "User not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of groups",
"tags": [
"Users",
@@ -21835,6 +21496,9 @@
},
{
"$ref": "#/components/parameters/permission_blogIds"
+ },
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
}
],
"responses": {
@@ -21895,11 +21559,6 @@
"description": "Site or User not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for user",
"tags": [
"Users",
@@ -21989,11 +21648,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to user",
"tags": [
"Users",
@@ -22083,11 +21737,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from user",
"tags": [
"Users",
@@ -22161,11 +21810,6 @@
"description": "Site or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Send the link for password recovery to specified user by email",
"tags": [
"Users"
@@ -22385,11 +22029,6 @@
"description": "Site or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Unlock user account",
"tags": [
"Users"
@@ -22447,6 +22086,11 @@
}
}
},
+ "security": [
+ {
+ "mtauth": []
+ }
+ ],
"servers": [
{
"url": "https://example.com/mt/mt-data-api.cgi/v2"
diff --git a/src/openapi/v2.yaml b/src/openapi/v2.yaml
index 5a624e8..4ff53a7 100644
--- a/src/openapi/v2.yaml
+++ b/src/openapi/v2.yaml
@@ -13,6 +13,16 @@ components:
name: fields
schema:
type: string
+ asset_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: class
+ in: query
+ name: filterKeys
+ schema:
+ default: class
+ type: string
asset_includeIds:
description: The comma separated ID list of assets to include to result.
in: query
@@ -95,6 +105,12 @@ components:
name: fields
schema:
type: string
+ category_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
category_includeIds:
description: The comma separated ID list of categories to include to result.
in: query
@@ -177,6 +193,16 @@ components:
name: fields
schema:
type: string
+ comment_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
comment_includeIds:
description: The comma separated ID list of comments to include to result.
in: query
@@ -259,6 +285,16 @@ components:
name: fields
schema:
type: string
+ entry_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
entry_includeIds:
description: The comma separated ID list of entries to include to result.
in: query
@@ -306,6 +342,15 @@ components:
schema:
default: 0
type: integer
+ entry_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
entry_search:
description: Search query.
in: query
@@ -413,6 +458,16 @@ components:
name: fields
schema:
type: string
+ field_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: systemObject,type
+ in: query
+ name: filterKeys
+ schema:
+ default: 'systemObject,type'
+ type: string
field_includeIds:
description: The comma separated ID list of fields to include to result.
in: query
@@ -495,6 +550,12 @@ components:
name: fields
schema:
type: string
+ folder_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
folder_includeIds:
description: The comma separated ID list of folders to include to result.
in: query
@@ -577,6 +638,12 @@ components:
name: fields
schema:
type: string
+ formatted_text_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
formatted_text_includeIds:
description: The comma separated ID list of formatted_texts to include to result.
in: query
@@ -659,6 +726,16 @@ components:
name: fields
schema:
type: string
+ group_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
group_includeIds:
description: The comma separated ID list of groups to include to result.
in: query
@@ -741,6 +818,16 @@ components:
name: fields
schema:
type: string
+ log_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: level
+ in: query
+ name: filterKeys
+ schema:
+ default: level
+ type: string
log_includeIds:
description: The comma separated ID list of logs to include to result.
in: query
@@ -823,6 +910,16 @@ components:
name: fields
schema:
type: string
+ page_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
page_includeIds:
description: The comma separated ID list of pages to include to result.
in: query
@@ -870,6 +967,15 @@ components:
schema:
default: 0
type: integer
+ page_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
page_search:
description: Search query.
in: query
@@ -983,6 +1089,16 @@ components:
name: fields
schema:
type: string
+ permission_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: blogIds
+ in: query
+ name: filterKeys
+ schema:
+ default: blogIds
+ type: string
permission_includeIds:
description: The comma separated ID list of permissions to include to result.
in: query
@@ -1077,6 +1193,12 @@ components:
name: fields
schema:
type: string
+ role_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
role_includeIds:
description: The comma separated ID list of roles to include to result.
in: query
@@ -1174,6 +1296,12 @@ components:
name: fields
schema:
type: string
+ site_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
site_includeIds:
description: The comma separated ID list of sites to include to result.
in: query
@@ -1262,6 +1390,12 @@ components:
name: fields
schema:
type: string
+ tag_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
tag_includeIds:
description: The comma separated ID list of tags to include to result.
in: query
@@ -1344,6 +1478,16 @@ components:
name: fields
schema:
type: string
+ template_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: type
+ in: query
+ name: filterKeys
+ schema:
+ default: type
+ type: string
template_includeIds:
description: The comma separated ID list of templates to include to result.
in: query
@@ -1370,6 +1514,15 @@ components:
schema:
default: 0
type: integer
+ template_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
template_search:
description: Search query.
in: query
@@ -1426,6 +1579,16 @@ components:
name: fields
schema:
type: string
+ templatemap_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: archiveType,buildType,isPreferred
+ in: query
+ name: filterKeys
+ schema:
+ default: 'archiveType,buildType,isPreferred'
+ type: string
templatemap_includeIds:
description: The comma separated ID list of templatemaps to include to result.
in: query
@@ -1504,6 +1667,16 @@ components:
name: fields
schema:
type: string
+ user_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status,lockout
+ in: query
+ name: filterKeys
+ schema:
+ default: 'status,lockout'
+ type: string
user_includeIds:
description: The comma separated ID list of users to include to result.
in: query
@@ -1586,6 +1759,12 @@ components:
name: fields
schema:
type: string
+ widget_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
widget_includeIds:
description: The comma separated ID list of widgets to include to result.
in: query
@@ -1668,6 +1847,12 @@ components:
name: fields
schema:
type: string
+ widgetset_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
widgetset_includeIds:
description: The comma separated ID list of widgetsets to include to result.
in: query
@@ -3747,7 +3932,7 @@ externalDocs:
url: https://www.movabletype.jp/developers/data-api/
info:
title: Movable Type Data API
- version: 8.6.0
+ version: 8.7.0
openapi: 3.0.0
paths:
/:
@@ -3873,8 +4058,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Upload file size is larger than CGIMaxUpload.
- security:
- - mtauth: []
summary: Upload a file
tags:
- Assets
@@ -4096,6 +4279,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
responses:
200:
content:
@@ -4126,8 +4310,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to retrieve the requested groups.
- security:
- - mtauth: []
summary: Retrieve a list of groups
tags:
- Groups
@@ -4161,8 +4343,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to create a group.
- security:
- - mtauth: []
summary: Create a new group
tags:
- Groups
@@ -4192,8 +4372,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to synchronize groups.
- security:
- - mtauth: []
summary: Synchronize groups
tags:
- Groups
@@ -4242,8 +4420,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a group
tags:
- Groups
@@ -4282,8 +4458,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve single group by its ID
tags:
- Groups
@@ -4339,8 +4513,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a group
tags:
- Groups
@@ -4359,6 +4531,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
responses:
200:
content:
@@ -4395,8 +4568,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve a list of members for specified group
tags:
- Groups
@@ -4445,8 +4616,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group or Member not found.
- security:
- - mtauth: []
tags:
- Groups
'/groups/{group_id}/members/{member_id}':
@@ -4499,8 +4668,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
tags:
- Groups
get:
@@ -4543,8 +4710,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group or Member not found.
- security:
- - mtauth: []
summary: Retrieve single member by its ID for specified group
tags:
- Groups
@@ -4565,6 +4730,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
responses:
200:
content:
@@ -4601,8 +4767,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for group
tags:
- Groups
@@ -4660,8 +4824,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Group not found
- security:
- - mtauth: []
summary: Grant permissions to group
tags:
- Groups
@@ -4719,8 +4881,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Group not found
- security:
- - mtauth: []
summary: Revoke permissions from group
tags:
- Groups
@@ -4737,6 +4897,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
responses:
200:
content:
@@ -4773,8 +4934,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions
tags:
- Permissions
@@ -4816,8 +4975,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of plugins in the specified site
tags:
- Plugins
@@ -4853,8 +5010,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Disable all plugins
tags:
- Plugins
@@ -4890,8 +5045,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Enable all plugins
tags:
- Plugins
@@ -4930,8 +5083,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found.
- security:
- - mtauth: []
summary: Retrieve single plugin by its ID
tags:
- Plugins
@@ -4973,8 +5124,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Disable a plugin
tags:
- Plugins
@@ -5016,8 +5165,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Enable a plugin
tags:
- Plugins
@@ -5094,8 +5241,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to publish.
- security:
- - mtauth: []
summary: Rebuild the static archives in relation to specified entries
tags:
- Entries
@@ -5194,8 +5339,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to retrieve the list of roles.
- security:
- - mtauth: []
summary: Retrieve a list of roles
tags:
- Roles
@@ -5235,8 +5378,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new role
tags:
- Roles
@@ -5285,8 +5426,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing role
tags:
- Roles
@@ -5325,8 +5464,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role not found.
- security:
- - mtauth: []
summary: Retrieve a single role by its ID
tags:
- Roles
@@ -5382,8 +5519,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing role
tags:
- Roles
@@ -5407,6 +5542,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
responses:
200:
content:
@@ -5443,8 +5579,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions by role
tags:
- Roles
@@ -5675,8 +5809,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new website
tags:
- Sites
@@ -5731,8 +5863,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing blog or website
tags:
- Sites
@@ -5831,8 +5961,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new blog
tags:
- Sites
@@ -5893,8 +6021,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing blog or website
tags:
- Sites
@@ -5915,6 +6041,7 @@ paths:
- $ref: '#/components/parameters/asset_searchFields'
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -6081,8 +6208,6 @@ paths:
type: object
type: object
description: Conflict
- security:
- - mtauth: []
summary: Upload a file
tags:
- Assets
@@ -6141,8 +6266,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an asset
tags:
- Assets
@@ -6256,8 +6379,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an asset
tags:
- Assets
@@ -6299,6 +6420,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
responses:
200:
content:
@@ -6377,6 +6499,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
responses:
200:
content:
@@ -6533,8 +6656,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Backup specified site
tags:
- Sites
@@ -6689,8 +6810,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new category
tags:
- Categories
@@ -6752,8 +6871,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Rearrange existing categories in a new order
tags:
- Categories
@@ -6813,8 +6930,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing category
tags:
- Categories
@@ -6928,8 +7043,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing category
tags:
- Categories
@@ -7052,6 +7165,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
responses:
200:
content:
@@ -7417,6 +7531,10 @@ paths:
- Future
- Spam
type: string
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
responses:
200:
content:
@@ -7509,8 +7627,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a comment
tags:
- Comments
@@ -7625,8 +7741,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a comment
tags:
- Comments
@@ -7773,6 +7887,7 @@ paths:
name: fields
schema:
type: string
+ - $ref: '#/components/parameters/entry_filterKeys'
responses:
200:
content:
@@ -7829,6 +7944,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/entry_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -7864,8 +7980,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new entry
tags:
- Entries
@@ -7904,8 +8018,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Export entries
tags:
- Entries
@@ -7988,8 +8100,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Import entries
tags:
- Entries
@@ -8057,8 +8167,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Entry not found
- security:
- - mtauth: []
summary: Make a preview for a entry
tags:
- Entries
@@ -8116,8 +8224,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an entry
tags:
- Entries
@@ -8213,6 +8319,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/entry_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -8254,8 +8361,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an entry
tags:
- Entries
@@ -8309,6 +8414,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_sortOrder'
- $ref: '#/components/parameters/asset_fields'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
responses:
200:
content:
@@ -8508,6 +8615,10 @@ paths:
name: offset
schema:
type: integer
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
responses:
200:
content:
@@ -8599,8 +8710,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Create a new comment on an entry
tags:
- Comments
@@ -8662,8 +8771,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Reply to specified comment
tags:
- Comments
@@ -8738,8 +8845,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Entry not found
- security:
- - mtauth: []
summary: Make a preview for a entry with existing data
tags:
- Entries
@@ -8788,8 +8893,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found
- security:
- - mtauth: []
summary: Export site's theme
tags:
- Themes
@@ -8808,6 +8911,7 @@ paths:
- $ref: '#/components/parameters/field_sortBy'
- $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/field_fields'
+ - $ref: '#/components/parameters/field_filterKeys'
responses:
200:
content:
@@ -8844,8 +8948,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of fields in the specified site
tags:
- CustomFields
@@ -8891,8 +8993,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new field
tags:
- CustomFields
@@ -8946,8 +9046,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a field
tags:
- CustomFields
@@ -8991,8 +9089,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Field not found.
- security:
- - mtauth: []
summary: Retrieve single field by its ID
tags:
- CustomFields
@@ -9053,8 +9149,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a field
tags:
- CustomFields
@@ -9204,8 +9298,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new folder.
tags:
- Folders
@@ -9267,8 +9359,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Rearrange existing folders in a new order
tags:
- Folders
@@ -9328,8 +9418,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing folder
tags:
- Folders
@@ -9443,8 +9531,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing folder
tags:
- Folders
@@ -9562,6 +9648,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
responses:
200:
content:
@@ -9834,8 +9921,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of formatted_texts in the specified site
tags:
- FormattedText
@@ -9881,8 +9966,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new formatted_text
tags:
- FormattedText
@@ -9936,8 +10019,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a formatted_text
tags:
- FormattedText
@@ -9981,8 +10062,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or FormattedText not found.
- security:
- - mtauth: []
summary: Retrieve single formatted_text by its ID
tags:
- FormattedText
@@ -10043,8 +10122,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a formatted_text
tags:
- FormattedText
@@ -10096,8 +10173,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Reset logs
tags:
- Logs
@@ -10119,6 +10194,7 @@ paths:
- $ref: '#/components/parameters/log_searchFields'
- $ref: '#/components/parameters/log_limit'
- $ref: '#/components/parameters/log_offset'
+ - $ref: '#/components/parameters/log_filterKeys'
- description: |
- id
- created_on
@@ -10206,8 +10282,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of logs in the specified site
tags:
- Logs
@@ -10253,8 +10327,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new log
tags:
- Logs
@@ -10297,8 +10369,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Export logs
tags:
- Logs
@@ -10352,8 +10422,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing log
tags:
- Logs
@@ -10397,8 +10465,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Log not found.
- security:
- - mtauth: []
summary: Retrieve a single log by its ID
tags:
- Logs
@@ -10459,8 +10525,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing log
tags:
- Logs
@@ -10497,6 +10561,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
responses:
200:
content:
@@ -10553,6 +10618,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/page_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -10588,8 +10654,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new page
tags:
- Pages
@@ -10657,8 +10721,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Page not found
- security:
- - mtauth: []
summary: Make a preview for a page
tags:
- Pages
@@ -10717,8 +10779,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing page
tags:
- Pages
@@ -10796,6 +10856,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/page_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -10837,8 +10898,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing page
tags:
- Pages
@@ -10862,6 +10921,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -10962,6 +11023,10 @@ paths:
name: offset
schema:
type: integer
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
responses:
200:
content:
@@ -11053,8 +11118,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Create a new comment on a page
tags:
- Comments
@@ -11116,8 +11179,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Reply to specified comment
tags:
- Comments
@@ -11192,8 +11253,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Page not found
- security:
- - mtauth: []
summary: Make a preview for a page with existing data
tags:
- Pages
@@ -11254,8 +11313,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for site
tags:
- Sites
@@ -11313,8 +11370,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Grant permissions to site
tags:
- Sites
@@ -11372,8 +11427,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Revoke permissions from site
tags:
- Sites
@@ -11442,8 +11495,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Reset all templates in the site
tags:
- Templates
@@ -11459,14 +11510,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -11488,7 +11539,7 @@ paths:
name: path
schema:
type: string
- - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
+ - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
in: query
name: uniquePath
schema:
@@ -11536,8 +11587,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve pageviews count for each date from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -11553,14 +11602,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -11622,8 +11671,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve visits count for each date from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -11639,14 +11686,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -11668,7 +11715,7 @@ paths:
name: path
schema:
type: string
- - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
+ - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
in: query
name: uniquePath
schema:
@@ -11716,8 +11763,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve pageviews count for each path from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -11733,14 +11778,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -11802,8 +11847,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve visits count for each path from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -11847,8 +11890,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve a current effective provider
tags:
- Statistics
@@ -11956,8 +11997,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing tag
tags:
- Tags
@@ -12061,8 +12100,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing tag
tags:
- Tags
@@ -12086,6 +12123,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -12192,6 +12231,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
responses:
200:
content:
@@ -12270,6 +12310,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
responses:
200:
content:
@@ -12328,6 +12369,7 @@ paths:
- $ref: '#/components/parameters/template_searchFields'
- $ref: '#/components/parameters/template_limit'
- $ref: '#/components/parameters/template_offset'
+ - $ref: '#/components/parameters/template_filterKeys'
- description: |
#### id
@@ -12416,8 +12458,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of templates in the specified site
tags:
- Templates
@@ -12434,6 +12474,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/template_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -12469,8 +12510,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new template
tags:
- Templates
@@ -12539,8 +12578,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Make a preview for a template
tags:
- Templates
@@ -12599,8 +12636,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a template
tags:
- Templates
@@ -12650,8 +12685,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Retrieve single template by its ID
tags:
- Templates
@@ -12676,6 +12709,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/template_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -12717,8 +12751,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a template
tags:
- Templates
@@ -12771,8 +12803,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Make a clone of a template
tags:
- Templates
@@ -12852,8 +12882,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Make a preview for a template with existing data
tags:
- Templates
@@ -12912,8 +12940,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Publish a template
tags:
- Templates
@@ -12970,8 +12996,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Reset template text to theme default or tempalte_set default
tags:
- Templates
@@ -12997,6 +13021,7 @@ paths:
- $ref: '#/components/parameters/templatemap_fields'
- $ref: '#/components/parameters/templatemap_includeIds'
- $ref: '#/components/parameters/templatemap_excludeIds'
+ - $ref: '#/components/parameters/templatemap_filterKeys'
responses:
200:
content:
@@ -13033,8 +13058,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Retrieve a list of templatemaps in the specified site
tags:
- Templates
@@ -13086,8 +13109,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Create a new templatemap
tags:
- Templates
@@ -13147,8 +13168,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing templatemap
tags:
- Templates
@@ -13197,8 +13216,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template or TemplateMap not found.
- security:
- - mtauth: []
summary: Retrieve a single templatemap by its ID
tags:
- Templates
@@ -13265,8 +13282,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing templatemap
tags:
- Templates
@@ -13321,8 +13336,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of themes for site
tags:
- Themes
@@ -13372,8 +13385,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found.
- security:
- - mtauth: []
summary: Retrieve a single theme by its ID for site
tags:
- Themes
@@ -13426,8 +13437,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found
- security:
- - mtauth: []
summary: Apply a theme to site
tags:
- Themes
@@ -13484,8 +13493,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgets in the specified site
tags:
- Widgets
@@ -13531,8 +13538,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new widget
tags:
- Widgets
@@ -13586,8 +13591,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a widget
tags:
- Widgets
@@ -13631,8 +13634,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found.
- security:
- - mtauth: []
summary: Retrieve a single widget by its ID
tags:
- Widgets
@@ -13693,8 +13694,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a widget
tags:
- Widgets
@@ -13741,8 +13740,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found
- security:
- - mtauth: []
summary: Make a clone of a widget
tags:
- Widgets
@@ -13793,8 +13790,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found
- security:
- - mtauth: []
summary: Reset widget text to default
tags:
- Widgets
@@ -13851,8 +13846,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgetsets in the specified site
tags:
- WidgetSets
@@ -13898,8 +13891,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new widgetset
tags:
- WidgetSets
@@ -13953,8 +13944,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing widgetset
tags:
- WidgetSets
@@ -13998,8 +13987,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or WidgetSet not found.
- security:
- - mtauth: []
summary: Retrieve a single widgetset by its ID
tags:
- WidgetSets
@@ -14060,8 +14047,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing widgetset
tags:
- WidgetSets
@@ -14123,8 +14108,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or WidgetSet not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgets in the specified widgetset
tags:
- Widgets
@@ -14175,8 +14158,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found.
- security:
- - mtauth: []
summary: Retrieve a single widget by widgetset ID
tags:
- Widgets
@@ -14225,8 +14206,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of themes
tags:
- Themes
@@ -14281,8 +14260,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Uninstall a specified theme from the MT
tags:
- Themes
@@ -14326,8 +14303,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found.
- security:
- - mtauth: []
summary: Retrieve a single theme by its ID
tags:
- Themes
@@ -14369,8 +14344,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Invalidate current session. This is like logout
tags:
- Authentication
@@ -14447,6 +14420,7 @@ paths:
- $ref: '#/components/parameters/user_searchFields'
- $ref: '#/components/parameters/user_limit'
- $ref: '#/components/parameters/user_offset'
+ - $ref: '#/components/parameters/user_filterKeys'
- description: |
The field name for sort. You can specify one of following values
- id
@@ -14585,8 +14559,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new user
tags:
- Users
@@ -14613,8 +14585,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to export users.
- security:
- - mtauth: []
summary: Export users
tags:
- Users
@@ -14659,8 +14629,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to import users.
- security:
- - mtauth: []
summary: Import users
tags:
- Users
@@ -14690,8 +14658,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to synchronize users.
- security:
- - mtauth: []
summary: Synchronize users
tags:
- Users
@@ -14746,8 +14712,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete user
tags:
- Users
@@ -14857,8 +14821,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update user data
tags:
- Users
@@ -14877,6 +14839,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
responses:
200:
content:
@@ -14913,8 +14876,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: User not found.
- security:
- - mtauth: []
summary: Retrieve a list of groups
tags:
- Users
@@ -14936,6 +14897,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
responses:
200:
content:
@@ -14972,8 +14934,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for user
tags:
- Users
@@ -15031,8 +14991,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Grant permissions to user
tags:
- Users
@@ -15090,8 +15048,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Revoke permissions from user
tags:
- Users
@@ -15142,8 +15098,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found
- security:
- - mtauth: []
summary: Send the link for password recovery to specified user by email
tags:
- Users
@@ -15304,8 +15258,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found
- security:
- - mtauth: []
summary: Unlock user account
tags:
- Users
@@ -15346,6 +15298,8 @@ paths:
summary: Get server API version
tags:
- Common API
+security:
+ - mtauth: []
servers:
- url: https://example.com/mt/mt-data-api.cgi/v2
tags:
diff --git a/src/openapi/v3.json b/src/openapi/v3.json
index bcafd23..49d00ea 100644
--- a/src/openapi/v3.json
+++ b/src/openapi/v3.json
@@ -42,6 +42,15 @@
"type": "string"
}
},
+ "asset_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: class",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "class",
+ "type": "string"
+ }
+ },
"asset_includeIds": {
"description": "The comma separated ID list of assets to include to result.",
"in": "query",
@@ -148,6 +157,14 @@
"type": "string"
}
},
+ "category_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"category_includeIds": {
"description": "The comma separated ID list of categories to include to result.",
"in": "query",
@@ -254,6 +271,15 @@
"type": "string"
}
},
+ "comment_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"comment_includeIds": {
"description": "The comma separated ID list of comments to include to result.",
"in": "query",
@@ -360,6 +386,15 @@
"type": "string"
}
},
+ "entry_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"entry_includeIds": {
"description": "The comma separated ID list of entries to include to result.",
"in": "query",
@@ -414,6 +449,18 @@
"type": "integer"
}
},
+ "entry_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"entry_search": {
"description": "Search query.",
"in": "query",
@@ -516,6 +563,15 @@
"type": "string"
}
},
+ "field_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: systemObject,type",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "systemObject,type",
+ "type": "string"
+ }
+ },
"field_includeIds": {
"description": "The comma separated ID list of fields to include to result.",
"in": "query",
@@ -622,6 +678,14 @@
"type": "string"
}
},
+ "folder_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"folder_includeIds": {
"description": "The comma separated ID list of folders to include to result.",
"in": "query",
@@ -728,6 +792,14 @@
"type": "string"
}
},
+ "formatted_text_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"formatted_text_includeIds": {
"description": "The comma separated ID list of formatted_texts to include to result.",
"in": "query",
@@ -834,6 +906,15 @@
"type": "string"
}
},
+ "group_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"group_includeIds": {
"description": "The comma separated ID list of groups to include to result.",
"in": "query",
@@ -940,6 +1021,15 @@
"type": "string"
}
},
+ "log_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: level",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "level",
+ "type": "string"
+ }
+ },
"log_includeIds": {
"description": "The comma separated ID list of logs to include to result.",
"in": "query",
@@ -1046,6 +1136,15 @@
"type": "string"
}
},
+ "page_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"page_includeIds": {
"description": "The comma separated ID list of pages to include to result.",
"in": "query",
@@ -1100,6 +1199,18 @@
"type": "integer"
}
},
+ "page_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"page_search": {
"description": "Search query.",
"in": "query",
@@ -1210,6 +1321,15 @@
"type": "string"
}
},
+ "permission_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: blogIds",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "blogIds",
+ "type": "string"
+ }
+ },
"permission_includeIds": {
"description": "The comma separated ID list of permissions to include to result.",
"in": "query",
@@ -1322,6 +1442,14 @@
"type": "string"
}
},
+ "role_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"role_includeIds": {
"description": "The comma separated ID list of roles to include to result.",
"in": "query",
@@ -1435,6 +1563,14 @@
"type": "string"
}
},
+ "site_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"site_includeIds": {
"description": "The comma separated ID list of sites to include to result.",
"in": "query",
@@ -1544,6 +1680,14 @@
"type": "string"
}
},
+ "tag_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"tag_includeIds": {
"description": "The comma separated ID list of tags to include to result.",
"in": "query",
@@ -1650,6 +1794,15 @@
"type": "string"
}
},
+ "template_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: type",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "type",
+ "type": "string"
+ }
+ },
"template_includeIds": {
"description": "The comma separated ID list of templates to include to result.",
"in": "query",
@@ -1676,6 +1829,18 @@
"type": "integer"
}
},
+ "template_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"template_search": {
"description": "Search query.",
"in": "query",
@@ -1756,6 +1921,15 @@
"type": "string"
}
},
+ "templatemap_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: archiveType,buildType,isPreferred",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "archiveType,buildType,isPreferred",
+ "type": "string"
+ }
+ },
"templatemap_includeIds": {
"description": "The comma separated ID list of templatemaps to include to result.",
"in": "query",
@@ -1861,6 +2035,15 @@
"type": "string"
}
},
+ "user_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status,lockout",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status,lockout",
+ "type": "string"
+ }
+ },
"user_includeIds": {
"description": "The comma separated ID list of users to include to result.",
"in": "query",
@@ -1967,6 +2150,14 @@
"type": "string"
}
},
+ "widget_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"widget_includeIds": {
"description": "The comma separated ID list of widgets to include to result.",
"in": "query",
@@ -2073,6 +2264,14 @@
"type": "string"
}
},
+ "widgetset_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"widgetset_includeIds": {
"description": "The comma separated ID list of widgetsets to include to result.",
"in": "query",
@@ -5235,7 +5434,7 @@
},
"info": {
"title": "Movable Type Data API",
- "version": "8.6.0"
+ "version": "8.7.0"
},
"openapi": "3.0.0",
"paths": {
@@ -5439,11 +5638,6 @@
"description": "Upload file size is larger than CGIMaxUpload."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Upload a file",
"tags": [
"Assets"
@@ -5783,6 +5977,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/group_dateField"
},
@@ -5841,11 +6038,6 @@
"description": "Do not have permission to retrieve the requested groups."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of groups",
"tags": [
"Groups"
@@ -5901,11 +6093,6 @@
"description": "Do not have permission to create a group."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new group",
"tags": [
"Groups"
@@ -5954,11 +6141,6 @@
"description": "Do not have permission to synchronize groups."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Synchronize groups",
"tags": [
"Groups"
@@ -6033,11 +6215,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a group",
"tags": [
"Groups"
@@ -6102,11 +6279,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single group by its ID",
"tags": [
"Groups"
@@ -6193,11 +6365,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a group",
"tags": [
"Groups"
@@ -6236,6 +6403,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/user_dateField"
},
@@ -6304,11 +6474,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of members for specified group",
"tags": [
"Groups"
@@ -6389,11 +6554,6 @@
"description": "Group or Member not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"tags": [
"Groups"
]
@@ -6475,11 +6635,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"tags": [
"Groups"
]
@@ -6551,11 +6706,6 @@
"description": "Group or Member not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single member by its ID for specified group",
"tags": [
"Groups"
@@ -6592,6 +6742,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -6660,11 +6813,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for group",
"tags": [
"Groups",
@@ -6754,11 +6902,6 @@
"description": "Site or Group not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to group",
"tags": [
"Groups",
@@ -6848,11 +6991,6 @@
"description": "Site or Group not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from group",
"tags": [
"Groups",
@@ -6882,6 +7020,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -6950,11 +7091,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions",
"tags": [
"Permissions"
@@ -7021,11 +7157,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of plugins in the specified site",
"tags": [
"Plugins"
@@ -7084,11 +7215,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Disable all plugins",
"tags": [
"Plugins"
@@ -7147,11 +7273,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Enable all plugins",
"tags": [
"Plugins"
@@ -7215,11 +7336,6 @@
"description": "Site or Plugin not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single plugin by its ID",
"tags": [
"Plugins"
@@ -7288,11 +7404,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Disable a plugin",
"tags": [
"Plugins"
@@ -7361,11 +7472,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Enable a plugin",
"tags": [
"Plugins"
@@ -7463,11 +7569,6 @@
"description": "Do not have permission to publish."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rebuild the static archives in relation to specified entries",
"tags": [
"Entries",
@@ -7635,11 +7736,6 @@
"description": "Do not have permission to retrieve the list of roles."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of roles",
"tags": [
"Roles"
@@ -7705,11 +7801,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new role",
"tags": [
"Roles"
@@ -7784,11 +7875,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing role",
"tags": [
"Roles"
@@ -7853,11 +7939,6 @@
"description": "Site or Role not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single role by its ID",
"tags": [
"Roles"
@@ -7944,11 +8025,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing role",
"tags": [
"Roles"
@@ -7985,6 +8061,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -8053,11 +8132,6 @@
"description": "Site or Role not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions by role",
"tags": [
"Roles",
@@ -8375,11 +8449,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new website",
"tags": [
"Sites"
@@ -8454,11 +8523,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing blog or website",
"tags": [
"Sites"
@@ -8612,11 +8676,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new blog",
"tags": [
"Sites"
@@ -8703,11 +8762,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing blog or website",
"tags": [
"Sites"
@@ -8745,6 +8799,9 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -8990,11 +9047,6 @@
"description": "Conflict"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Upload a file",
"tags": [
"Assets"
@@ -9077,11 +9129,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an asset",
"tags": [
"Assets"
@@ -9256,11 +9303,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an asset",
"tags": [
"Assets"
@@ -9334,6 +9376,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -9476,6 +9521,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -9738,11 +9786,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Backup specified site",
"tags": [
"Sites",
@@ -9964,11 +10007,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new category",
"tags": [
"Categories"
@@ -10052,11 +10090,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rearrange existing categories in a new order",
"tags": [
"Categories"
@@ -10139,11 +10172,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing category",
"tags": [
"Categories"
@@ -10318,11 +10346,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing category",
"tags": [
"Categories"
@@ -10507,6 +10530,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -11045,6 +11071,18 @@
"type": "string"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -11195,11 +11233,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a comment",
"tags": [
"Comments"
@@ -11372,11 +11405,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a comment",
"tags": [
"Comments"
@@ -11517,6 +11545,9 @@
"type": "string"
}
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -11600,6 +11631,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_saveRevision"
}
],
"requestBody": {
@@ -11669,11 +11703,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new entry",
"tags": [
"Entries"
@@ -11737,11 +11766,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export entries",
"tags": [
"Entries"
@@ -11857,11 +11881,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Import entries",
"tags": [
"Entries"
@@ -11961,11 +11980,6 @@
"description": "Site or Entry not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a entry",
"tags": [
"Entries"
@@ -12048,11 +12062,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an entry",
"tags": [
"Entries"
@@ -12178,6 +12187,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_saveRevision"
}
],
"requestBody": {
@@ -12257,11 +12269,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an entry",
"tags": [
"Entries"
@@ -12329,6 +12336,12 @@
{
"$ref": "#/components/parameters/asset_fields"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"$ref": "#/components/parameters/asset_dateField"
},
@@ -12611,6 +12624,18 @@
"type": "integer"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -12764,11 +12789,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new comment on an entry",
"tags": [
"Comments",
@@ -12864,11 +12884,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reply to specified comment",
"tags": [
"Comments",
@@ -12977,11 +12992,6 @@
"description": "Site or Entry not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a entry with existing data",
"tags": [
"Entries"
@@ -13051,11 +13061,6 @@
"description": "Site or Theme not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export site's theme",
"tags": [
"Themes"
@@ -13094,6 +13099,9 @@
{
"$ref": "#/components/parameters/field_fields"
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
{
"$ref": "#/components/parameters/field_dateField"
},
@@ -13162,11 +13170,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of fields in the specified site",
"tags": [
"CustomFields"
@@ -13242,11 +13245,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new field",
"tags": [
"CustomFields"
@@ -13329,11 +13327,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a field",
"tags": [
"CustomFields"
@@ -13406,11 +13399,6 @@
"description": "Site or Field not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single field by its ID",
"tags": [
"CustomFields"
@@ -13505,11 +13493,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a field",
"tags": [
"CustomFields"
@@ -13721,11 +13704,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new folder.",
"tags": [
"Folders"
@@ -13809,11 +13787,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rearrange existing folders in a new order",
"tags": [
"Folders"
@@ -13896,11 +13869,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing folder",
"tags": [
"Folders"
@@ -14075,11 +14043,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing folder",
"tags": [
"Folders"
@@ -14255,6 +14218,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -14681,11 +14647,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of formatted_texts in the specified site",
"tags": [
"FormattedText"
@@ -14761,11 +14722,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new formatted_text",
"tags": [
"FormattedText"
@@ -14848,11 +14804,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a formatted_text",
"tags": [
"FormattedText"
@@ -14925,11 +14876,6 @@
"description": "Site or FormattedText not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single formatted_text by its ID",
"tags": [
"FormattedText"
@@ -15024,11 +14970,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a formatted_text",
"tags": [
"FormattedText"
@@ -15108,11 +15049,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset logs",
"tags": [
"Logs"
@@ -15141,6 +15077,9 @@
{
"$ref": "#/components/parameters/log_offset"
},
+ {
+ "$ref": "#/components/parameters/log_filterKeys"
+ },
{
"description": "- id\n- created_on\n- blog_id\n- author_id\n- level\n- class\n\n**Default**: created_on\n",
"in": "query",
@@ -15257,11 +15196,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of logs in the specified site",
"tags": [
"Logs"
@@ -15337,11 +15271,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new log",
"tags": [
"Logs"
@@ -15412,11 +15341,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export logs",
"tags": [
"Logs"
@@ -15499,11 +15423,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing log",
"tags": [
"Logs"
@@ -15576,11 +15495,6 @@
"description": "Site or Log not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single log by its ID",
"tags": [
"Logs"
@@ -15675,11 +15589,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing log",
"tags": [
"Logs"
@@ -15745,6 +15654,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -15828,6 +15740,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/page_saveRevision"
}
],
"requestBody": {
@@ -15897,11 +15812,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new page",
"tags": [
"Pages"
@@ -16001,11 +15911,6 @@
"description": "Site or Page not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a page",
"tags": [
"Pages"
@@ -16088,11 +15993,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing page",
"tags": [
"Pages"
@@ -16197,6 +16097,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/page_saveRevision"
}
],
"requestBody": {
@@ -16276,11 +16179,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing page",
"tags": [
"Pages"
@@ -16320,6 +16218,12 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -16465,6 +16369,18 @@
"type": "integer"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -16618,11 +16534,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new comment on a page",
"tags": [
"Comments",
@@ -16718,11 +16629,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reply to specified comment",
"tags": [
"Comments",
@@ -16831,11 +16737,6 @@
"description": "Site or Page not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a page with existing data",
"tags": [
"Pages"
@@ -16937,11 +16838,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for site",
"tags": [
"Sites",
@@ -17031,11 +16927,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to site",
"tags": [
"Sites",
@@ -17125,11 +17016,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from site",
"tags": [
"Sites",
@@ -17213,11 +17099,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset all templates in the site",
"tags": [
"Templates"
@@ -17237,7 +17118,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -17247,7 +17128,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -17281,7 +17162,7 @@
}
},
{
- "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
"in": "query",
"name": "uniquePath",
"schema": {
@@ -17357,11 +17238,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve pageviews count for each date from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -17381,7 +17257,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -17391,7 +17267,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -17489,11 +17365,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve visits count for each date from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -17513,7 +17384,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -17523,7 +17394,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -17557,7 +17428,7 @@
}
},
{
- "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
"in": "query",
"name": "uniquePath",
"schema": {
@@ -17633,11 +17504,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve pageviews count for each path from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -17657,7 +17523,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -17667,7 +17533,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -17765,11 +17631,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve visits count for each path from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -17836,11 +17697,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a current effective provider",
"tags": [
"Statistics"
@@ -18029,11 +17885,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing tag",
"tags": [
"Tags"
@@ -18200,11 +18051,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing tag",
"tags": [
"Tags"
@@ -18244,6 +18090,12 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -18412,6 +18264,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -18554,6 +18409,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -18653,6 +18511,9 @@
{
"$ref": "#/components/parameters/template_offset"
},
+ {
+ "$ref": "#/components/parameters/template_filterKeys"
+ },
{
"description": "#### id\n\nSort by the ID of each template.\n\n#### name\n\nSort by the name of each template.\n\n#### created_on\n\nSort by the created time of each template.\n\n#### modified_on\n\nSort by the modified time of each template.\n\n#### created_by\n\nSort by the ID of user who created each template.\n\n#### modified_by\n\nSort by the ID of user who modified each template.\n\n#### type\n\nSort by the type of each template.\n\n**Default**: name\n",
"in": "query",
@@ -18759,11 +18620,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of templates in the specified site",
"tags": [
"Templates"
@@ -18779,6 +18635,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/template_saveRevision"
}
],
"requestBody": {
@@ -18840,11 +18699,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new template",
"tags": [
"Templates"
@@ -18944,11 +18798,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a template",
"tags": [
"Templates"
@@ -19031,11 +18880,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a template",
"tags": [
"Templates"
@@ -19109,11 +18953,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single template by its ID",
"tags": [
"Templates"
@@ -19137,6 +18976,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/template_saveRevision"
}
],
"requestBody": {
@@ -19208,11 +19050,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a template",
"tags": [
"Templates"
@@ -19290,11 +19127,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a clone of a template",
"tags": [
"Templates"
@@ -19402,11 +19234,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a template with existing data",
"tags": [
"Templates"
@@ -19484,11 +19311,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Publish a template",
"tags": [
"Templates"
@@ -19572,11 +19394,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset template text to theme default or tempalte_set default",
"tags": [
"Templates"
@@ -19629,6 +19446,9 @@
{
"$ref": "#/components/parameters/templatemap_excludeIds"
},
+ {
+ "$ref": "#/components/parameters/templatemap_filterKeys"
+ },
{
"$ref": "#/components/parameters/templatemap_dateField"
},
@@ -19697,11 +19517,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of templatemaps in the specified site",
"tags": [
"Templates",
@@ -19786,11 +19601,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new templatemap",
"tags": [
"Templates",
@@ -19882,11 +19692,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing templatemap",
"tags": [
"Templates",
@@ -19965,11 +19770,6 @@
"description": "Site or Template or TemplateMap not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single templatemap by its ID",
"tags": [
"Templates",
@@ -20073,11 +19873,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing templatemap",
"tags": [
"Templates",
@@ -20156,11 +19951,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of themes for site",
"tags": [
"Themes"
@@ -20233,11 +20023,6 @@
"description": "Site or Theme not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single theme by its ID for site",
"tags": [
"Themes"
@@ -20315,11 +20100,6 @@
"description": "Site or Theme not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Apply a theme to site",
"tags": [
"Themes"
@@ -20432,11 +20212,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgets in the specified site",
"tags": [
"Widgets"
@@ -20512,11 +20287,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new widget",
"tags": [
"Widgets"
@@ -20599,11 +20369,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a widget",
"tags": [
"Widgets"
@@ -20676,11 +20441,6 @@
"description": "Site or Widget not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widget by its ID",
"tags": [
"Widgets"
@@ -20775,11 +20535,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a widget",
"tags": [
"Widgets"
@@ -20856,11 +20611,6 @@
"description": "Site or Widget not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a clone of a widget",
"tags": [
"Widgets"
@@ -20943,11 +20693,6 @@
"description": "Site or Widget not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset widget text to default",
"tags": [
"Widgets"
@@ -21060,11 +20805,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgetsets in the specified site",
"tags": [
"WidgetSets"
@@ -21140,11 +20880,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new widgetset",
"tags": [
"WidgetSets"
@@ -21227,11 +20962,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing widgetset",
"tags": [
"WidgetSets"
@@ -21304,11 +21034,6 @@
"description": "Site or WidgetSet not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widgetset by its ID",
"tags": [
"WidgetSets"
@@ -21403,11 +21128,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing widgetset",
"tags": [
"WidgetSets"
@@ -21528,11 +21248,6 @@
"description": "Site or WidgetSet not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgets in the specified widgetset",
"tags": [
"Widgets",
@@ -21616,11 +21331,6 @@
"description": "Site or Widget not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widget by widgetset ID",
"tags": [
"Widgets",
@@ -21689,11 +21399,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of themes",
"tags": [
"Themes"
@@ -21768,11 +21473,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Uninstall a specified theme from the MT",
"tags": [
"Themes"
@@ -21835,11 +21535,6 @@
"description": "Site or Theme not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single theme by its ID",
"tags": [
"Themes"
@@ -21897,11 +21592,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Invalidate current session. This is like logout",
"tags": [
"Authentication"
@@ -22006,6 +21696,9 @@
{
"$ref": "#/components/parameters/user_offset"
},
+ {
+ "$ref": "#/components/parameters/user_filterKeys"
+ },
{
"description": "The field name for sort. You can specify one of following values\n- id\n- name\n\n**Default**: name\n",
"in": "query",
@@ -22190,11 +21883,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new user",
"tags": [
"Users"
@@ -22238,11 +21926,6 @@
"description": "Do not have permission to export users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export users",
"tags": [
"Users"
@@ -22315,11 +21998,6 @@
"description": "Do not have permission to import users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Import users",
"tags": [
"Users"
@@ -22368,11 +22046,6 @@
"description": "Do not have permission to synchronize users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Synchronize users",
"tags": [
"Users"
@@ -22447,11 +22120,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete user",
"tags": [
"Users"
@@ -22616,11 +22284,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update user data",
"tags": [
"Users"
@@ -22659,6 +22322,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/group_dateField"
},
@@ -22727,11 +22393,6 @@
"description": "User not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of groups",
"tags": [
"Users",
@@ -22769,6 +22430,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -22837,11 +22501,6 @@
"description": "Site or User not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for user",
"tags": [
"Users",
@@ -22931,11 +22590,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to user",
"tags": [
"Users",
@@ -23025,11 +22679,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from user",
"tags": [
"Users",
@@ -23103,11 +22752,6 @@
"description": "Site or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Send the link for password recovery to specified user by email",
"tags": [
"Users"
@@ -23336,11 +22980,6 @@
"description": "Site or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Unlock user account",
"tags": [
"Users"
@@ -23398,6 +23037,11 @@
}
}
},
+ "security": [
+ {
+ "mtauth": []
+ }
+ ],
"servers": [
{
"url": "https://example.com/mt/mt-data-api.cgi/v3"
diff --git a/src/openapi/v3.yaml b/src/openapi/v3.yaml
index 73b5930..aadae05 100644
--- a/src/openapi/v3.yaml
+++ b/src/openapi/v3.yaml
@@ -32,6 +32,16 @@ components:
name: fields
schema:
type: string
+ asset_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: class
+ in: query
+ name: filterKeys
+ schema:
+ default: class
+ type: string
asset_includeIds:
description: The comma separated ID list of assets to include to result.
in: query
@@ -133,6 +143,12 @@ components:
name: fields
schema:
type: string
+ category_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
category_includeIds:
description: The comma separated ID list of categories to include to result.
in: query
@@ -234,6 +250,16 @@ components:
name: fields
schema:
type: string
+ comment_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
comment_includeIds:
description: The comma separated ID list of comments to include to result.
in: query
@@ -335,6 +361,16 @@ components:
name: fields
schema:
type: string
+ entry_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
entry_includeIds:
description: The comma separated ID list of entries to include to result.
in: query
@@ -382,6 +418,15 @@ components:
schema:
default: 0
type: integer
+ entry_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
entry_search:
description: Search query.
in: query
@@ -508,6 +553,16 @@ components:
name: fields
schema:
type: string
+ field_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: systemObject,type
+ in: query
+ name: filterKeys
+ schema:
+ default: 'systemObject,type'
+ type: string
field_includeIds:
description: The comma separated ID list of fields to include to result.
in: query
@@ -609,6 +664,12 @@ components:
name: fields
schema:
type: string
+ folder_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
folder_includeIds:
description: The comma separated ID list of folders to include to result.
in: query
@@ -710,6 +771,12 @@ components:
name: fields
schema:
type: string
+ formatted_text_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
formatted_text_includeIds:
description: The comma separated ID list of formatted_texts to include to result.
in: query
@@ -811,6 +878,16 @@ components:
name: fields
schema:
type: string
+ group_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
group_includeIds:
description: The comma separated ID list of groups to include to result.
in: query
@@ -912,6 +989,16 @@ components:
name: fields
schema:
type: string
+ log_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: level
+ in: query
+ name: filterKeys
+ schema:
+ default: level
+ type: string
log_includeIds:
description: The comma separated ID list of logs to include to result.
in: query
@@ -1013,6 +1100,16 @@ components:
name: fields
schema:
type: string
+ page_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
page_includeIds:
description: The comma separated ID list of pages to include to result.
in: query
@@ -1060,6 +1157,15 @@ components:
schema:
default: 0
type: integer
+ page_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
page_search:
description: Search query.
in: query
@@ -1192,6 +1298,16 @@ components:
name: fields
schema:
type: string
+ permission_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: blogIds
+ in: query
+ name: filterKeys
+ schema:
+ default: blogIds
+ type: string
permission_includeIds:
description: The comma separated ID list of permissions to include to result.
in: query
@@ -1305,6 +1421,12 @@ components:
name: fields
schema:
type: string
+ role_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
role_includeIds:
description: The comma separated ID list of roles to include to result.
in: query
@@ -1421,6 +1543,12 @@ components:
name: fields
schema:
type: string
+ site_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
site_includeIds:
description: The comma separated ID list of sites to include to result.
in: query
@@ -1528,6 +1656,12 @@ components:
name: fields
schema:
type: string
+ tag_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
tag_includeIds:
description: The comma separated ID list of tags to include to result.
in: query
@@ -1629,6 +1763,16 @@ components:
name: fields
schema:
type: string
+ template_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: type
+ in: query
+ name: filterKeys
+ schema:
+ default: type
+ type: string
template_includeIds:
description: The comma separated ID list of templates to include to result.
in: query
@@ -1655,6 +1799,15 @@ components:
schema:
default: 0
type: integer
+ template_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
template_search:
description: Search query.
in: query
@@ -1730,6 +1883,16 @@ components:
name: fields
schema:
type: string
+ templatemap_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: archiveType,buildType,isPreferred
+ in: query
+ name: filterKeys
+ schema:
+ default: 'archiveType,buildType,isPreferred'
+ type: string
templatemap_includeIds:
description: The comma separated ID list of templatemaps to include to result.
in: query
@@ -1827,6 +1990,16 @@ components:
name: fields
schema:
type: string
+ user_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status,lockout
+ in: query
+ name: filterKeys
+ schema:
+ default: 'status,lockout'
+ type: string
user_includeIds:
description: The comma separated ID list of users to include to result.
in: query
@@ -1928,6 +2101,12 @@ components:
name: fields
schema:
type: string
+ widget_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
widget_includeIds:
description: The comma separated ID list of widgets to include to result.
in: query
@@ -2029,6 +2208,12 @@ components:
name: fields
schema:
type: string
+ widgetset_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
widgetset_includeIds:
description: The comma separated ID list of widgetsets to include to result.
in: query
@@ -4146,7 +4331,7 @@ externalDocs:
url: https://www.movabletype.jp/developers/data-api/
info:
title: Movable Type Data API
- version: 8.6.0
+ version: 8.7.0
openapi: 3.0.0
paths:
/:
@@ -4278,8 +4463,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Upload file size is larger than CGIMaxUpload.
- security:
- - mtauth: []
summary: Upload a file
tags:
- Assets
@@ -4501,6 +4684,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/group_dateField'
- $ref: '#/components/parameters/group_dateFrom'
- $ref: '#/components/parameters/group_dateTo'
@@ -4534,8 +4718,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to retrieve the requested groups.
- security:
- - mtauth: []
summary: Retrieve a list of groups
tags:
- Groups
@@ -4569,8 +4751,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to create a group.
- security:
- - mtauth: []
summary: Create a new group
tags:
- Groups
@@ -4600,8 +4780,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to synchronize groups.
- security:
- - mtauth: []
summary: Synchronize groups
tags:
- Groups
@@ -4650,8 +4828,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a group
tags:
- Groups
@@ -4690,8 +4866,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve single group by its ID
tags:
- Groups
@@ -4747,8 +4921,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a group
tags:
- Groups
@@ -4767,6 +4939,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/user_dateField'
- $ref: '#/components/parameters/user_dateFrom'
- $ref: '#/components/parameters/user_dateTo'
@@ -4806,8 +4979,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve a list of members for specified group
tags:
- Groups
@@ -4856,8 +5027,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group or Member not found.
- security:
- - mtauth: []
tags:
- Groups
'/groups/{group_id}/members/{member_id}':
@@ -4910,8 +5079,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
tags:
- Groups
get:
@@ -4954,8 +5121,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group or Member not found.
- security:
- - mtauth: []
summary: Retrieve single member by its ID for specified group
tags:
- Groups
@@ -4976,6 +5141,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -5015,8 +5181,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for group
tags:
- Groups
@@ -5074,8 +5238,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Group not found
- security:
- - mtauth: []
summary: Grant permissions to group
tags:
- Groups
@@ -5133,8 +5295,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Group not found
- security:
- - mtauth: []
summary: Revoke permissions from group
tags:
- Groups
@@ -5151,6 +5311,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -5190,8 +5351,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions
tags:
- Permissions
@@ -5233,8 +5392,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of plugins in the specified site
tags:
- Plugins
@@ -5270,8 +5427,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Disable all plugins
tags:
- Plugins
@@ -5307,8 +5462,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Enable all plugins
tags:
- Plugins
@@ -5347,8 +5500,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found.
- security:
- - mtauth: []
summary: Retrieve single plugin by its ID
tags:
- Plugins
@@ -5390,8 +5541,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Disable a plugin
tags:
- Plugins
@@ -5433,8 +5582,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Enable a plugin
tags:
- Plugins
@@ -5511,8 +5658,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to publish.
- security:
- - mtauth: []
summary: Rebuild the static archives in relation to specified entries
tags:
- Entries
@@ -5614,8 +5759,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to retrieve the list of roles.
- security:
- - mtauth: []
summary: Retrieve a list of roles
tags:
- Roles
@@ -5655,8 +5798,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new role
tags:
- Roles
@@ -5705,8 +5846,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing role
tags:
- Roles
@@ -5745,8 +5884,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role not found.
- security:
- - mtauth: []
summary: Retrieve a single role by its ID
tags:
- Roles
@@ -5802,8 +5939,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing role
tags:
- Roles
@@ -5827,6 +5962,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -5866,8 +6002,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions by role
tags:
- Roles
@@ -6101,8 +6235,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new website
tags:
- Sites
@@ -6157,8 +6289,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing blog or website
tags:
- Sites
@@ -6257,8 +6387,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new blog
tags:
- Sites
@@ -6319,8 +6447,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing blog or website
tags:
- Sites
@@ -6341,6 +6467,7 @@ paths:
- $ref: '#/components/parameters/asset_searchFields'
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -6512,8 +6639,6 @@ paths:
type: object
type: object
description: Conflict
- security:
- - mtauth: []
summary: Upload a file
tags:
- Assets
@@ -6572,8 +6697,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an asset
tags:
- Assets
@@ -6687,8 +6810,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an asset
tags:
- Assets
@@ -6730,6 +6851,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -6811,6 +6933,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -6970,8 +7093,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Backup specified site
tags:
- Sites
@@ -7129,8 +7250,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new category
tags:
- Categories
@@ -7192,8 +7311,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Rearrange existing categories in a new order
tags:
- Categories
@@ -7253,8 +7370,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing category
tags:
- Categories
@@ -7368,8 +7483,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing category
tags:
- Categories
@@ -7492,6 +7605,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -7866,6 +7980,10 @@ paths:
- Future
- Spam
type: string
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -7961,8 +8079,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a comment
tags:
- Comments
@@ -8077,8 +8193,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a comment
tags:
- Comments
@@ -8225,6 +8339,7 @@ paths:
name: fields
schema:
type: string
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -8284,6 +8399,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/entry_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -8325,8 +8441,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new entry
tags:
- Entries
@@ -8365,8 +8479,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Export entries
tags:
- Entries
@@ -8449,8 +8561,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Import entries
tags:
- Entries
@@ -8518,8 +8628,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Entry not found
- security:
- - mtauth: []
summary: Make a preview for a entry
tags:
- Entries
@@ -8577,8 +8685,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an entry
tags:
- Entries
@@ -8674,6 +8780,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/entry_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -8721,8 +8828,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an entry
tags:
- Entries
@@ -8776,6 +8881,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_sortOrder'
- $ref: '#/components/parameters/asset_fields'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- $ref: '#/components/parameters/asset_dateField'
- $ref: '#/components/parameters/asset_dateFrom'
- $ref: '#/components/parameters/asset_dateTo'
@@ -8981,6 +9088,10 @@ paths:
name: offset
schema:
type: integer
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -9075,8 +9186,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Create a new comment on an entry
tags:
- Comments
@@ -9138,8 +9247,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Reply to specified comment
tags:
- Comments
@@ -9214,8 +9321,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Entry not found
- security:
- - mtauth: []
summary: Make a preview for a entry with existing data
tags:
- Entries
@@ -9264,8 +9369,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found
- security:
- - mtauth: []
summary: Export site's theme
tags:
- Themes
@@ -9284,6 +9387,7 @@ paths:
- $ref: '#/components/parameters/field_sortBy'
- $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/field_fields'
+ - $ref: '#/components/parameters/field_filterKeys'
- $ref: '#/components/parameters/field_dateField'
- $ref: '#/components/parameters/field_dateFrom'
- $ref: '#/components/parameters/field_dateTo'
@@ -9323,8 +9427,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of fields in the specified site
tags:
- CustomFields
@@ -9370,8 +9472,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new field
tags:
- CustomFields
@@ -9425,8 +9525,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a field
tags:
- CustomFields
@@ -9470,8 +9568,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Field not found.
- security:
- - mtauth: []
summary: Retrieve single field by its ID
tags:
- CustomFields
@@ -9532,8 +9628,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a field
tags:
- CustomFields
@@ -9686,8 +9780,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new folder.
tags:
- Folders
@@ -9749,8 +9841,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Rearrange existing folders in a new order
tags:
- Folders
@@ -9810,8 +9900,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing folder
tags:
- Folders
@@ -9925,8 +10013,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing folder
tags:
- Folders
@@ -10044,6 +10130,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -10325,8 +10412,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of formatted_texts in the specified site
tags:
- FormattedText
@@ -10372,8 +10457,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new formatted_text
tags:
- FormattedText
@@ -10427,8 +10510,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a formatted_text
tags:
- FormattedText
@@ -10472,8 +10553,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or FormattedText not found.
- security:
- - mtauth: []
summary: Retrieve single formatted_text by its ID
tags:
- FormattedText
@@ -10534,8 +10613,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a formatted_text
tags:
- FormattedText
@@ -10587,8 +10664,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Reset logs
tags:
- Logs
@@ -10610,6 +10685,7 @@ paths:
- $ref: '#/components/parameters/log_searchFields'
- $ref: '#/components/parameters/log_limit'
- $ref: '#/components/parameters/log_offset'
+ - $ref: '#/components/parameters/log_filterKeys'
- description: |
- id
- created_on
@@ -10700,8 +10776,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of logs in the specified site
tags:
- Logs
@@ -10747,8 +10821,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new log
tags:
- Logs
@@ -10791,8 +10863,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Export logs
tags:
- Logs
@@ -10846,8 +10916,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing log
tags:
- Logs
@@ -10891,8 +10959,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Log not found.
- security:
- - mtauth: []
summary: Retrieve a single log by its ID
tags:
- Logs
@@ -10953,8 +11019,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing log
tags:
- Logs
@@ -10991,6 +11055,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -11050,6 +11115,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/page_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -11091,8 +11157,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new page
tags:
- Pages
@@ -11160,8 +11224,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Page not found
- security:
- - mtauth: []
summary: Make a preview for a page
tags:
- Pages
@@ -11220,8 +11282,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing page
tags:
- Pages
@@ -11299,6 +11359,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/page_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -11346,8 +11407,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing page
tags:
- Pages
@@ -11371,6 +11430,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -11474,6 +11535,10 @@ paths:
name: offset
schema:
type: integer
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -11568,8 +11633,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Create a new comment on a page
tags:
- Comments
@@ -11631,8 +11694,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Reply to specified comment
tags:
- Comments
@@ -11707,8 +11768,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Page not found
- security:
- - mtauth: []
summary: Make a preview for a page with existing data
tags:
- Pages
@@ -11772,8 +11831,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for site
tags:
- Sites
@@ -11831,8 +11888,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Grant permissions to site
tags:
- Sites
@@ -11890,8 +11945,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Revoke permissions from site
tags:
- Sites
@@ -11960,8 +12013,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Reset all templates in the site
tags:
- Templates
@@ -11977,14 +12028,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -12006,7 +12057,7 @@ paths:
name: path
schema:
type: string
- - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
+ - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
in: query
name: uniquePath
schema:
@@ -12054,8 +12105,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve pageviews count for each date from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -12071,14 +12120,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -12140,8 +12189,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve visits count for each date from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -12157,14 +12204,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -12186,7 +12233,7 @@ paths:
name: path
schema:
type: string
- - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
+ - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
in: query
name: uniquePath
schema:
@@ -12234,8 +12281,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve pageviews count for each path from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -12251,14 +12296,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -12320,8 +12365,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve visits count for each path from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -12365,8 +12408,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve a current effective provider
tags:
- Statistics
@@ -12477,8 +12518,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing tag
tags:
- Tags
@@ -12582,8 +12621,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing tag
tags:
- Tags
@@ -12607,6 +12644,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -12716,6 +12755,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -12797,6 +12837,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -12858,6 +12899,7 @@ paths:
- $ref: '#/components/parameters/template_searchFields'
- $ref: '#/components/parameters/template_limit'
- $ref: '#/components/parameters/template_offset'
+ - $ref: '#/components/parameters/template_filterKeys'
- description: |
#### id
@@ -12949,8 +12991,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of templates in the specified site
tags:
- Templates
@@ -12967,6 +13007,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/template_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -13002,8 +13043,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new template
tags:
- Templates
@@ -13072,8 +13111,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Make a preview for a template
tags:
- Templates
@@ -13132,8 +13169,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a template
tags:
- Templates
@@ -13183,8 +13218,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Retrieve single template by its ID
tags:
- Templates
@@ -13209,6 +13242,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/template_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -13250,8 +13284,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a template
tags:
- Templates
@@ -13304,8 +13336,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Make a clone of a template
tags:
- Templates
@@ -13385,8 +13415,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Make a preview for a template with existing data
tags:
- Templates
@@ -13445,8 +13473,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Publish a template
tags:
- Templates
@@ -13503,8 +13529,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Reset template text to theme default or tempalte_set default
tags:
- Templates
@@ -13530,6 +13554,7 @@ paths:
- $ref: '#/components/parameters/templatemap_fields'
- $ref: '#/components/parameters/templatemap_includeIds'
- $ref: '#/components/parameters/templatemap_excludeIds'
+ - $ref: '#/components/parameters/templatemap_filterKeys'
- $ref: '#/components/parameters/templatemap_dateField'
- $ref: '#/components/parameters/templatemap_dateFrom'
- $ref: '#/components/parameters/templatemap_dateTo'
@@ -13569,8 +13594,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Retrieve a list of templatemaps in the specified site
tags:
- Templates
@@ -13622,8 +13645,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Create a new templatemap
tags:
- Templates
@@ -13683,8 +13704,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing templatemap
tags:
- Templates
@@ -13733,8 +13752,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template or TemplateMap not found.
- security:
- - mtauth: []
summary: Retrieve a single templatemap by its ID
tags:
- Templates
@@ -13801,8 +13818,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing templatemap
tags:
- Templates
@@ -13857,8 +13872,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of themes for site
tags:
- Themes
@@ -13908,8 +13921,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found.
- security:
- - mtauth: []
summary: Retrieve a single theme by its ID for site
tags:
- Themes
@@ -13962,8 +13973,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found
- security:
- - mtauth: []
summary: Apply a theme to site
tags:
- Themes
@@ -14023,8 +14032,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgets in the specified site
tags:
- Widgets
@@ -14070,8 +14077,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new widget
tags:
- Widgets
@@ -14125,8 +14130,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a widget
tags:
- Widgets
@@ -14170,8 +14173,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found.
- security:
- - mtauth: []
summary: Retrieve a single widget by its ID
tags:
- Widgets
@@ -14232,8 +14233,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a widget
tags:
- Widgets
@@ -14280,8 +14279,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found
- security:
- - mtauth: []
summary: Make a clone of a widget
tags:
- Widgets
@@ -14332,8 +14329,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found
- security:
- - mtauth: []
summary: Reset widget text to default
tags:
- Widgets
@@ -14393,8 +14388,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgetsets in the specified site
tags:
- WidgetSets
@@ -14440,8 +14433,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new widgetset
tags:
- WidgetSets
@@ -14495,8 +14486,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing widgetset
tags:
- WidgetSets
@@ -14540,8 +14529,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or WidgetSet not found.
- security:
- - mtauth: []
summary: Retrieve a single widgetset by its ID
tags:
- WidgetSets
@@ -14602,8 +14589,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing widgetset
tags:
- WidgetSets
@@ -14668,8 +14653,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or WidgetSet not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgets in the specified widgetset
tags:
- Widgets
@@ -14720,8 +14703,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found.
- security:
- - mtauth: []
summary: Retrieve a single widget by widgetset ID
tags:
- Widgets
@@ -14770,8 +14751,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of themes
tags:
- Themes
@@ -14826,8 +14805,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Uninstall a specified theme from the MT
tags:
- Themes
@@ -14871,8 +14848,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found.
- security:
- - mtauth: []
summary: Retrieve a single theme by its ID
tags:
- Themes
@@ -14914,8 +14889,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Invalidate current session. This is like logout
tags:
- Authentication
@@ -14992,6 +14965,7 @@ paths:
- $ref: '#/components/parameters/user_searchFields'
- $ref: '#/components/parameters/user_limit'
- $ref: '#/components/parameters/user_offset'
+ - $ref: '#/components/parameters/user_filterKeys'
- description: |
The field name for sort. You can specify one of following values
- id
@@ -15133,8 +15107,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new user
tags:
- Users
@@ -15161,8 +15133,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to export users.
- security:
- - mtauth: []
summary: Export users
tags:
- Users
@@ -15207,8 +15177,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to import users.
- security:
- - mtauth: []
summary: Import users
tags:
- Users
@@ -15238,8 +15206,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to synchronize users.
- security:
- - mtauth: []
summary: Synchronize users
tags:
- Users
@@ -15294,8 +15260,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete user
tags:
- Users
@@ -15405,8 +15369,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update user data
tags:
- Users
@@ -15425,6 +15387,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/group_dateField'
- $ref: '#/components/parameters/group_dateFrom'
- $ref: '#/components/parameters/group_dateTo'
@@ -15464,8 +15427,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: User not found.
- security:
- - mtauth: []
summary: Retrieve a list of groups
tags:
- Users
@@ -15487,6 +15448,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -15526,8 +15488,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for user
tags:
- Users
@@ -15585,8 +15545,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Grant permissions to user
tags:
- Users
@@ -15644,8 +15602,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Revoke permissions from user
tags:
- Users
@@ -15696,8 +15652,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found
- security:
- - mtauth: []
summary: Send the link for password recovery to specified user by email
tags:
- Users
@@ -15861,8 +15815,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found
- security:
- - mtauth: []
summary: Unlock user account
tags:
- Users
@@ -15903,6 +15855,8 @@ paths:
summary: Get server API version
tags:
- Common API
+security:
+ - mtauth: []
servers:
- url: https://example.com/mt/mt-data-api.cgi/v3
tags:
diff --git a/src/openapi/v4.json b/src/openapi/v4.json
index 1893ac0..178e5f3 100644
--- a/src/openapi/v4.json
+++ b/src/openapi/v4.json
@@ -42,6 +42,15 @@
"type": "string"
}
},
+ "asset_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: class",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "class",
+ "type": "string"
+ }
+ },
"asset_includeIds": {
"description": "The comma separated ID list of assets to include to result.",
"in": "query",
@@ -148,6 +157,14 @@
"type": "string"
}
},
+ "category_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"category_includeIds": {
"description": "The comma separated ID list of categories to include to result.",
"in": "query",
@@ -232,6 +249,14 @@
"type": "string"
}
},
+ "category_set_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"category_set_includeIds": {
"description": "The comma separated ID list of category_sets to include to result.",
"in": "query",
@@ -354,6 +379,15 @@
"type": "string"
}
},
+ "comment_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"comment_includeIds": {
"description": "The comma separated ID list of comments to include to result.",
"in": "query",
@@ -460,6 +494,15 @@
"type": "string"
}
},
+ "content_data_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"content_data_includeIds": {
"description": "The comma separated ID list of content_data to include to result.",
"in": "query",
@@ -486,6 +529,18 @@
"type": "integer"
}
},
+ "content_data_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"content_data_search": {
"description": "Search query.",
"in": "query",
@@ -566,6 +621,14 @@
"type": "string"
}
},
+ "content_field_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"content_field_includeIds": {
"description": "The comma separated ID list of content_fields to include to result.",
"in": "query",
@@ -672,6 +735,14 @@
"type": "string"
}
},
+ "content_type_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"content_type_includeIds": {
"description": "The comma separated ID list of content_types to include to result.",
"in": "query",
@@ -778,6 +849,15 @@
"type": "string"
}
},
+ "entry_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"entry_includeIds": {
"description": "The comma separated ID list of entries to include to result.",
"in": "query",
@@ -832,6 +912,18 @@
"type": "integer"
}
},
+ "entry_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"entry_search": {
"description": "Search query.",
"in": "query",
@@ -934,6 +1026,15 @@
"type": "string"
}
},
+ "field_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: systemObject,type",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "systemObject,type",
+ "type": "string"
+ }
+ },
"field_includeIds": {
"description": "The comma separated ID list of fields to include to result.",
"in": "query",
@@ -1040,6 +1141,14 @@
"type": "string"
}
},
+ "folder_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"folder_includeIds": {
"description": "The comma separated ID list of folders to include to result.",
"in": "query",
@@ -1146,6 +1255,14 @@
"type": "string"
}
},
+ "formatted_text_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"formatted_text_includeIds": {
"description": "The comma separated ID list of formatted_texts to include to result.",
"in": "query",
@@ -1252,6 +1369,15 @@
"type": "string"
}
},
+ "group_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"group_includeIds": {
"description": "The comma separated ID list of groups to include to result.",
"in": "query",
@@ -1358,6 +1484,15 @@
"type": "string"
}
},
+ "log_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: level",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "level",
+ "type": "string"
+ }
+ },
"log_includeIds": {
"description": "The comma separated ID list of logs to include to result.",
"in": "query",
@@ -1464,6 +1599,15 @@
"type": "string"
}
},
+ "page_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"page_includeIds": {
"description": "The comma separated ID list of pages to include to result.",
"in": "query",
@@ -1518,6 +1662,18 @@
"type": "integer"
}
},
+ "page_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"page_search": {
"description": "Search query.",
"in": "query",
@@ -1628,6 +1784,15 @@
"type": "string"
}
},
+ "permission_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: blogIds",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "blogIds",
+ "type": "string"
+ }
+ },
"permission_includeIds": {
"description": "The comma separated ID list of permissions to include to result.",
"in": "query",
@@ -1740,6 +1905,14 @@
"type": "string"
}
},
+ "role_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"role_includeIds": {
"description": "The comma separated ID list of roles to include to result.",
"in": "query",
@@ -1853,6 +2026,14 @@
"type": "string"
}
},
+ "site_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"site_includeIds": {
"description": "The comma separated ID list of sites to include to result.",
"in": "query",
@@ -1962,6 +2143,14 @@
"type": "string"
}
},
+ "tag_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"tag_includeIds": {
"description": "The comma separated ID list of tags to include to result.",
"in": "query",
@@ -2068,6 +2257,15 @@
"type": "string"
}
},
+ "template_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: type",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "type",
+ "type": "string"
+ }
+ },
"template_includeIds": {
"description": "The comma separated ID list of templates to include to result.",
"in": "query",
@@ -2094,6 +2292,18 @@
"type": "integer"
}
},
+ "template_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"template_search": {
"description": "Search query.",
"in": "query",
@@ -2174,6 +2384,15 @@
"type": "string"
}
},
+ "templatemap_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: archiveType,buildType,isPreferred",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "archiveType,buildType,isPreferred",
+ "type": "string"
+ }
+ },
"templatemap_includeIds": {
"description": "The comma separated ID list of templatemaps to include to result.",
"in": "query",
@@ -2279,6 +2498,15 @@
"type": "string"
}
},
+ "user_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status,lockout",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status,lockout",
+ "type": "string"
+ }
+ },
"user_includeIds": {
"description": "The comma separated ID list of users to include to result.",
"in": "query",
@@ -2385,6 +2613,14 @@
"type": "string"
}
},
+ "widget_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"widget_includeIds": {
"description": "The comma separated ID list of widgets to include to result.",
"in": "query",
@@ -2491,6 +2727,14 @@
"type": "string"
}
},
+ "widgetset_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"widgetset_includeIds": {
"description": "The comma separated ID list of widgetsets to include to result.",
"in": "query",
@@ -6135,7 +6379,7 @@
},
"info": {
"title": "Movable Type Data API",
- "version": "8.6.0"
+ "version": "8.7.0"
},
"openapi": "3.0.0",
"paths": {
@@ -6339,11 +6583,6 @@
"description": "Upload file size is larger than CGIMaxUpload."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Upload a file",
"tags": [
"Assets"
@@ -6683,6 +6922,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/group_dateField"
},
@@ -6741,11 +6983,6 @@
"description": "Do not have permission to retrieve the requested groups."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of groups",
"tags": [
"Groups"
@@ -6801,11 +7038,6 @@
"description": "Do not have permission to create a group."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new group",
"tags": [
"Groups"
@@ -6854,11 +7086,6 @@
"description": "Do not have permission to synchronize groups."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Synchronize groups",
"tags": [
"Groups"
@@ -6933,11 +7160,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a group",
"tags": [
"Groups"
@@ -7002,11 +7224,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single group by its ID",
"tags": [
"Groups"
@@ -7093,11 +7310,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a group",
"tags": [
"Groups"
@@ -7136,6 +7348,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/user_dateField"
},
@@ -7204,11 +7419,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of members for specified group",
"tags": [
"Groups"
@@ -7289,11 +7499,6 @@
"description": "Group or Member not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"tags": [
"Groups"
]
@@ -7375,11 +7580,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"tags": [
"Groups"
]
@@ -7451,11 +7651,6 @@
"description": "Group or Member not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single member by its ID for specified group",
"tags": [
"Groups"
@@ -7492,6 +7687,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -7560,11 +7758,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for group",
"tags": [
"Groups",
@@ -7654,11 +7847,6 @@
"description": "Site or Group not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to group",
"tags": [
"Groups",
@@ -7748,11 +7936,6 @@
"description": "Site or Group not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from group",
"tags": [
"Groups",
@@ -7782,6 +7965,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -7850,11 +8036,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions",
"tags": [
"Permissions"
@@ -7921,11 +8102,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of plugins in the specified site",
"tags": [
"Plugins"
@@ -7984,11 +8160,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Disable all plugins",
"tags": [
"Plugins"
@@ -8047,11 +8218,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Enable all plugins",
"tags": [
"Plugins"
@@ -8115,11 +8281,6 @@
"description": "Site or Plugin not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single plugin by its ID",
"tags": [
"Plugins"
@@ -8188,11 +8349,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Disable a plugin",
"tags": [
"Plugins"
@@ -8261,11 +8417,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Enable a plugin",
"tags": [
"Plugins"
@@ -8358,11 +8509,6 @@
"description": "Do not have permission to publish content_data."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Publish Content Data",
"tags": [
"Content Data",
@@ -8461,11 +8607,6 @@
"description": "Do not have permission to publish."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rebuild the static archives in relation to specified entries",
"tags": [
"Entries",
@@ -8633,11 +8774,6 @@
"description": "Do not have permission to retrieve the list of roles."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of roles",
"tags": [
"Roles"
@@ -8703,11 +8839,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new role",
"tags": [
"Roles"
@@ -8782,11 +8913,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing role",
"tags": [
"Roles"
@@ -8851,11 +8977,6 @@
"description": "Site or Role not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single role by its ID",
"tags": [
"Roles"
@@ -8942,11 +9063,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing role",
"tags": [
"Roles"
@@ -8983,6 +9099,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -9051,11 +9170,6 @@
"description": "Site or Role not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions by role",
"tags": [
"Roles",
@@ -9389,11 +9503,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new website",
"tags": [
"Sites"
@@ -9468,11 +9577,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing blog or website",
"tags": [
"Sites"
@@ -9626,11 +9730,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new blog",
"tags": [
"Sites"
@@ -9717,11 +9816,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing blog or website",
"tags": [
"Sites"
@@ -9759,6 +9853,9 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -10004,11 +10101,6 @@
"description": "Conflict"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Upload a file",
"tags": [
"Assets"
@@ -10091,11 +10183,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an asset",
"tags": [
"Assets"
@@ -10270,11 +10357,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an asset",
"tags": [
"Assets"
@@ -10348,6 +10430,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -10490,6 +10575,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -10752,11 +10840,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Backup specified site",
"tags": [
"Sites",
@@ -10978,11 +11061,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new category",
"tags": [
"Categories"
@@ -11066,11 +11144,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rearrange existing categories in a new order",
"tags": [
"Categories"
@@ -11153,11 +11226,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing category",
"tags": [
"Categories"
@@ -11332,11 +11400,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing category",
"tags": [
"Categories"
@@ -11521,6 +11584,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -12061,11 +12127,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new category set",
"tags": [
"Category Sets"
@@ -12148,11 +12209,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete category set",
"tags": [
"Category Sets"
@@ -12328,11 +12384,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update category set",
"tags": [
"Category Sets"
@@ -12388,6 +12439,21 @@
"type": "integer"
}
},
+ {
+ "$ref": "#/components/parameters/category_limit"
+ },
+ {
+ "$ref": "#/components/parameters/category_offset"
+ },
+ {
+ "$ref": "#/components/parameters/category_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/category_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/category_sortOrder"
+ },
{
"$ref": "#/components/parameters/category_dateField"
},
@@ -12539,11 +12605,6 @@
"description": "Site pr Category_set not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new category for category set",
"tags": [
"Categories",
@@ -12636,11 +12697,6 @@
"description": "Site or Category_set not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Save hierarchical categories order in category set",
"tags": [
"Categories",
@@ -12732,11 +12788,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete single category in category set",
"tags": [
"Categories",
@@ -12930,11 +12981,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update single category in category set",
"tags": [
"Categories",
@@ -13546,6 +13592,18 @@
"type": "string"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -13696,11 +13754,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a comment",
"tags": [
"Comments"
@@ -13873,11 +13926,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a comment",
"tags": [
"Comments"
@@ -13902,6 +13950,9 @@
{
"$ref": "#/components/parameters/content_type_offset"
},
+ {
+ "$ref": "#/components/parameters/content_type_searchFields"
+ },
{
"description": "The field name for sort. You can specify one of following values.\n- name\n- dataLabel\n- uniqueID\n- modified_on\n",
"in": "query",
@@ -13994,11 +14045,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Content Type Collection",
"tags": [
"Content Types"
@@ -14075,11 +14121,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create Content Type",
"tags": [
"Content Types"
@@ -14162,11 +14203,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete Content Type",
"tags": [
"Content Types"
@@ -14240,11 +14276,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Fetch single Content Type",
"tags": [
"Content Types"
@@ -14339,11 +14370,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update Content Type",
"tags": [
"Content Types"
@@ -14428,6 +14454,12 @@
{
"$ref": "#/components/parameters/content_data_excludeIds"
},
+ {
+ "$ref": "#/components/parameters/content_data_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/content_data_searchFields"
+ },
{
"$ref": "#/components/parameters/content_data_dateField"
},
@@ -14518,6 +14550,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/content_data_saveRevision"
}
],
"requestBody": {
@@ -14579,11 +14614,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create Content Data",
"tags": [
"Content Types",
@@ -14692,11 +14722,6 @@
"description": "Site or Content_type not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview by data",
"tags": [
"Content Types",
@@ -14788,11 +14813,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete single content data",
"tags": [
"Content Types",
@@ -14915,6 +14935,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/content_data_saveRevision"
}
],
"requestBody": {
@@ -14986,11 +15009,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update Content Data",
"tags": [
"Content Types",
@@ -15107,11 +15125,6 @@
"description": "Site or Content_type or Content_data not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview by id",
"tags": [
"Content Types",
@@ -15145,6 +15158,9 @@
{
"$ref": "#/components/parameters/content_field_offset"
},
+ {
+ "$ref": "#/components/parameters/content_field_searchFields"
+ },
{
"description": "The field name for sort. You can specify one of following values.\n- name\n- dataLabel\n- uniqueID\n- modified_on\n",
"in": "query",
@@ -15237,11 +15253,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Content Field Collection",
"tags": [
"Content Fields",
@@ -15327,11 +15338,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create Content Field",
"tags": [
"Content Types",
@@ -15424,11 +15430,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Save hierarchical content field order",
"tags": [
"Content Types",
@@ -15520,11 +15521,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete Content Field",
"tags": [
"Content Types",
@@ -15607,11 +15603,6 @@
"description": "Site or Content_type or Content_field not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Fetch single Content Field",
"tags": [
"Content Types",
@@ -15715,11 +15706,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update Content Field",
"tags": [
"Content Types",
@@ -15861,6 +15847,9 @@
"type": "string"
}
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -15944,6 +15933,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_saveRevision"
}
],
"requestBody": {
@@ -16013,11 +16005,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new entry",
"tags": [
"Entries"
@@ -16081,11 +16068,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export entries",
"tags": [
"Entries"
@@ -16201,11 +16183,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Import entries",
"tags": [
"Entries"
@@ -16305,11 +16282,6 @@
"description": "Site or Entry not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a entry",
"tags": [
"Entries"
@@ -16392,11 +16364,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an entry",
"tags": [
"Entries"
@@ -16522,6 +16489,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_saveRevision"
}
],
"requestBody": {
@@ -16601,11 +16571,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an entry",
"tags": [
"Entries"
@@ -16673,6 +16638,12 @@
{
"$ref": "#/components/parameters/asset_fields"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"$ref": "#/components/parameters/asset_dateField"
},
@@ -16955,6 +16926,18 @@
"type": "integer"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -17108,11 +17091,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new comment on an entry",
"tags": [
"Comments",
@@ -17208,11 +17186,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reply to specified comment",
"tags": [
"Comments",
@@ -17321,11 +17294,6 @@
"description": "Site or Entry not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a entry with existing data",
"tags": [
"Entries"
@@ -17395,11 +17363,6 @@
"description": "Site or Theme not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export site's theme",
"tags": [
"Themes"
@@ -17438,6 +17401,9 @@
{
"$ref": "#/components/parameters/field_fields"
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
{
"$ref": "#/components/parameters/field_dateField"
},
@@ -17506,11 +17472,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of fields in the specified site",
"tags": [
"CustomFields"
@@ -17586,11 +17547,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new field",
"tags": [
"CustomFields"
@@ -17673,11 +17629,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a field",
"tags": [
"CustomFields"
@@ -17750,11 +17701,6 @@
"description": "Site or Field not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single field by its ID",
"tags": [
"CustomFields"
@@ -17849,11 +17795,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a field",
"tags": [
"CustomFields"
@@ -18065,11 +18006,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new folder.",
"tags": [
"Folders"
@@ -18153,11 +18089,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rearrange existing folders in a new order",
"tags": [
"Folders"
@@ -18240,11 +18171,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing folder",
"tags": [
"Folders"
@@ -18419,11 +18345,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing folder",
"tags": [
"Folders"
@@ -18599,6 +18520,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -19025,11 +18949,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of formatted_texts in the specified site",
"tags": [
"FormattedText"
@@ -19105,11 +19024,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new formatted_text",
"tags": [
"FormattedText"
@@ -19192,11 +19106,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a formatted_text",
"tags": [
"FormattedText"
@@ -19269,11 +19178,6 @@
"description": "Site or FormattedText not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single formatted_text by its ID",
"tags": [
"FormattedText"
@@ -19368,11 +19272,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a formatted_text",
"tags": [
"FormattedText"
@@ -19452,11 +19351,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset logs",
"tags": [
"Logs"
@@ -19485,6 +19379,9 @@
{
"$ref": "#/components/parameters/log_offset"
},
+ {
+ "$ref": "#/components/parameters/log_filterKeys"
+ },
{
"description": "- id\n- created_on\n- blog_id\n- author_id\n- level\n- class\n\n**Default**: created_on\n",
"in": "query",
@@ -19601,11 +19498,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of logs in the specified site",
"tags": [
"Logs"
@@ -19681,11 +19573,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new log",
"tags": [
"Logs"
@@ -19756,11 +19643,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export logs",
"tags": [
"Logs"
@@ -19843,11 +19725,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing log",
"tags": [
"Logs"
@@ -19920,11 +19797,6 @@
"description": "Site or Log not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single log by its ID",
"tags": [
"Logs"
@@ -20019,11 +19891,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing log",
"tags": [
"Logs"
@@ -20089,6 +19956,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -20172,6 +20042,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/page_saveRevision"
}
],
"requestBody": {
@@ -20241,11 +20114,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new page",
"tags": [
"Pages"
@@ -20345,11 +20213,6 @@
"description": "Site or Page not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a page",
"tags": [
"Pages"
@@ -20432,11 +20295,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing page",
"tags": [
"Pages"
@@ -20541,6 +20399,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/page_saveRevision"
}
],
"requestBody": {
@@ -20620,11 +20481,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing page",
"tags": [
"Pages"
@@ -20664,6 +20520,12 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -20809,6 +20671,18 @@
"type": "integer"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -20962,11 +20836,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new comment on a page",
"tags": [
"Comments",
@@ -21062,11 +20931,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reply to specified comment",
"tags": [
"Comments",
@@ -21175,11 +21039,6 @@
"description": "Site or Page not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a page with existing data",
"tags": [
"Pages"
@@ -21281,11 +21140,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for site",
"tags": [
"Sites",
@@ -21375,11 +21229,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to site",
"tags": [
"Sites",
@@ -21469,11 +21318,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from site",
"tags": [
"Sites",
@@ -21557,11 +21401,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset all templates in the site",
"tags": [
"Templates"
@@ -21581,7 +21420,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -21591,7 +21430,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -21625,7 +21464,7 @@
}
},
{
- "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
"in": "query",
"name": "uniquePath",
"schema": {
@@ -21701,11 +21540,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve pageviews count for each date from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -21725,7 +21559,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -21735,7 +21569,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -21833,11 +21667,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve visits count for each date from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -21857,7 +21686,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -21867,7 +21696,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -21901,7 +21730,7 @@
}
},
{
- "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
"in": "query",
"name": "uniquePath",
"schema": {
@@ -21977,11 +21806,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve pageviews count for each path from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -22001,7 +21825,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -22011,7 +21835,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -22109,11 +21933,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve visits count for each path from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -22180,11 +21999,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a current effective provider",
"tags": [
"Statistics"
@@ -22373,11 +22187,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing tag",
"tags": [
"Tags"
@@ -22544,11 +22353,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing tag",
"tags": [
"Tags"
@@ -22588,6 +22392,12 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -22756,6 +22566,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -22898,6 +22711,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -22997,6 +22813,9 @@
{
"$ref": "#/components/parameters/template_offset"
},
+ {
+ "$ref": "#/components/parameters/template_filterKeys"
+ },
{
"description": "#### id\n\nSort by the ID of each template.\n\n#### name\n\nSort by the name of each template.\n\n#### created_on\n\nSort by the created time of each template.\n\n#### modified_on\n\nSort by the modified time of each template.\n\n#### created_by\n\nSort by the ID of user who created each template.\n\n#### modified_by\n\nSort by the ID of user who modified each template.\n\n#### type\n\nSort by the type of each template.\n\n**Default**: name\n",
"in": "query",
@@ -23103,11 +22922,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of templates in the specified site",
"tags": [
"Templates"
@@ -23123,6 +22937,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/template_saveRevision"
}
],
"requestBody": {
@@ -23184,11 +23001,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new template",
"tags": [
"Templates"
@@ -23288,11 +23100,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a template",
"tags": [
"Templates"
@@ -23375,11 +23182,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a template",
"tags": [
"Templates"
@@ -23453,11 +23255,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single template by its ID",
"tags": [
"Templates"
@@ -23481,6 +23278,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/template_saveRevision"
}
],
"requestBody": {
@@ -23552,11 +23352,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a template",
"tags": [
"Templates"
@@ -23634,11 +23429,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a clone of a template",
"tags": [
"Templates"
@@ -23746,11 +23536,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a template with existing data",
"tags": [
"Templates"
@@ -23828,11 +23613,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Publish a template",
"tags": [
"Templates"
@@ -23916,11 +23696,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset template text to theme default or tempalte_set default",
"tags": [
"Templates"
@@ -23973,6 +23748,9 @@
{
"$ref": "#/components/parameters/templatemap_excludeIds"
},
+ {
+ "$ref": "#/components/parameters/templatemap_filterKeys"
+ },
{
"$ref": "#/components/parameters/templatemap_dateField"
},
@@ -24041,11 +23819,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of templatemaps in the specified site",
"tags": [
"Templates",
@@ -24130,11 +23903,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new templatemap",
"tags": [
"Templates",
@@ -24226,11 +23994,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing templatemap",
"tags": [
"Templates",
@@ -24309,11 +24072,6 @@
"description": "Site or Template or TemplateMap not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single templatemap by its ID",
"tags": [
"Templates",
@@ -24417,11 +24175,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing templatemap",
"tags": [
"Templates",
@@ -24500,11 +24253,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of themes for site",
"tags": [
"Themes"
@@ -24577,11 +24325,6 @@
"description": "Site or Theme not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single theme by its ID for site",
"tags": [
"Themes"
@@ -24659,11 +24402,6 @@
"description": "Site or Theme not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Apply a theme to site",
"tags": [
"Themes"
@@ -24776,11 +24514,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgets in the specified site",
"tags": [
"Widgets"
@@ -24856,11 +24589,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new widget",
"tags": [
"Widgets"
@@ -24943,11 +24671,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a widget",
"tags": [
"Widgets"
@@ -25020,11 +24743,6 @@
"description": "Site or Widget not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widget by its ID",
"tags": [
"Widgets"
@@ -25119,11 +24837,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a widget",
"tags": [
"Widgets"
@@ -25200,11 +24913,6 @@
"description": "Site or Widget not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a clone of a widget",
"tags": [
"Widgets"
@@ -25287,11 +24995,6 @@
"description": "Site or Widget not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset widget text to default",
"tags": [
"Widgets"
@@ -25404,11 +25107,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgetsets in the specified site",
"tags": [
"WidgetSets"
@@ -25484,11 +25182,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new widgetset",
"tags": [
"WidgetSets"
@@ -25571,11 +25264,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing widgetset",
"tags": [
"WidgetSets"
@@ -25648,11 +25336,6 @@
"description": "Site or WidgetSet not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widgetset by its ID",
"tags": [
"WidgetSets"
@@ -25747,11 +25430,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing widgetset",
"tags": [
"WidgetSets"
@@ -25872,11 +25550,6 @@
"description": "Site or WidgetSet not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgets in the specified widgetset",
"tags": [
"Widgets",
@@ -25960,11 +25633,6 @@
"description": "Site or Widget not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widget by widgetset ID",
"tags": [
"Widgets",
@@ -26033,11 +25701,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of themes",
"tags": [
"Themes"
@@ -26112,11 +25775,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Uninstall a specified theme from the MT",
"tags": [
"Themes"
@@ -26179,11 +25837,6 @@
"description": "Site or Theme not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single theme by its ID",
"tags": [
"Themes"
@@ -26241,11 +25894,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Invalidate current session. This is like logout",
"tags": [
"Authentication"
@@ -26350,6 +25998,9 @@
{
"$ref": "#/components/parameters/user_offset"
},
+ {
+ "$ref": "#/components/parameters/user_filterKeys"
+ },
{
"description": "The field name for sort. You can specify one of following values\n- id\n- name\n\n**Default**: name\n",
"in": "query",
@@ -26534,11 +26185,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new user",
"tags": [
"Users"
@@ -26582,11 +26228,6 @@
"description": "Do not have permission to export users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export users",
"tags": [
"Users"
@@ -26659,11 +26300,6 @@
"description": "Do not have permission to import users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Import users",
"tags": [
"Users"
@@ -26712,11 +26348,6 @@
"description": "Do not have permission to synchronize users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Synchronize users",
"tags": [
"Users"
@@ -26791,11 +26422,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete user",
"tags": [
"Users"
@@ -26960,11 +26586,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update user data",
"tags": [
"Users"
@@ -27003,6 +26624,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/group_dateField"
},
@@ -27071,11 +26695,6 @@
"description": "User not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of groups",
"tags": [
"Users",
@@ -27113,6 +26732,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -27181,11 +26803,6 @@
"description": "Site or User not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for user",
"tags": [
"Users",
@@ -27275,11 +26892,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to user",
"tags": [
"Users",
@@ -27369,11 +26981,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from user",
"tags": [
"Users",
@@ -27447,11 +27054,6 @@
"description": "Site or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Send the link for password recovery to specified user by email",
"tags": [
"Users"
@@ -27680,11 +27282,6 @@
"description": "Site or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Unlock user account",
"tags": [
"Users"
@@ -27742,6 +27339,11 @@
}
}
},
+ "security": [
+ {
+ "mtauth": []
+ }
+ ],
"servers": [
{
"url": "https://example.com/mt/mt-data-api.cgi/v4"
diff --git a/src/openapi/v4.yaml b/src/openapi/v4.yaml
index a56a438..6acb66b 100644
--- a/src/openapi/v4.yaml
+++ b/src/openapi/v4.yaml
@@ -32,6 +32,16 @@ components:
name: fields
schema:
type: string
+ asset_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: class
+ in: query
+ name: filterKeys
+ schema:
+ default: class
+ type: string
asset_includeIds:
description: The comma separated ID list of assets to include to result.
in: query
@@ -133,6 +143,12 @@ components:
name: fields
schema:
type: string
+ category_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
category_includeIds:
description: The comma separated ID list of categories to include to result.
in: query
@@ -206,6 +222,12 @@ components:
name: fields
schema:
type: string
+ category_set_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
category_set_includeIds:
description: The comma separated ID list of category_sets to include to result.
in: query
@@ -317,6 +339,16 @@ components:
name: fields
schema:
type: string
+ comment_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
comment_includeIds:
description: The comma separated ID list of comments to include to result.
in: query
@@ -418,6 +450,16 @@ components:
name: fields
schema:
type: string
+ content_data_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
content_data_includeIds:
description: The comma separated ID list of content_data to include to result.
in: query
@@ -444,6 +486,15 @@ components:
schema:
default: 0
type: integer
+ content_data_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
content_data_search:
description: Search query.
in: query
@@ -519,6 +570,12 @@ components:
name: fields
schema:
type: string
+ content_field_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
content_field_includeIds:
description: The comma separated ID list of content_fields to include to result.
in: query
@@ -620,6 +677,12 @@ components:
name: fields
schema:
type: string
+ content_type_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
content_type_includeIds:
description: The comma separated ID list of content_types to include to result.
in: query
@@ -721,6 +784,16 @@ components:
name: fields
schema:
type: string
+ entry_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
entry_includeIds:
description: The comma separated ID list of entries to include to result.
in: query
@@ -768,6 +841,15 @@ components:
schema:
default: 0
type: integer
+ entry_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
entry_search:
description: Search query.
in: query
@@ -894,6 +976,16 @@ components:
name: fields
schema:
type: string
+ field_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: systemObject,type
+ in: query
+ name: filterKeys
+ schema:
+ default: 'systemObject,type'
+ type: string
field_includeIds:
description: The comma separated ID list of fields to include to result.
in: query
@@ -995,6 +1087,12 @@ components:
name: fields
schema:
type: string
+ folder_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
folder_includeIds:
description: The comma separated ID list of folders to include to result.
in: query
@@ -1096,6 +1194,12 @@ components:
name: fields
schema:
type: string
+ formatted_text_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
formatted_text_includeIds:
description: The comma separated ID list of formatted_texts to include to result.
in: query
@@ -1197,6 +1301,16 @@ components:
name: fields
schema:
type: string
+ group_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
group_includeIds:
description: The comma separated ID list of groups to include to result.
in: query
@@ -1298,6 +1412,16 @@ components:
name: fields
schema:
type: string
+ log_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: level
+ in: query
+ name: filterKeys
+ schema:
+ default: level
+ type: string
log_includeIds:
description: The comma separated ID list of logs to include to result.
in: query
@@ -1399,6 +1523,16 @@ components:
name: fields
schema:
type: string
+ page_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
page_includeIds:
description: The comma separated ID list of pages to include to result.
in: query
@@ -1446,6 +1580,15 @@ components:
schema:
default: 0
type: integer
+ page_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
page_search:
description: Search query.
in: query
@@ -1578,6 +1721,16 @@ components:
name: fields
schema:
type: string
+ permission_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: blogIds
+ in: query
+ name: filterKeys
+ schema:
+ default: blogIds
+ type: string
permission_includeIds:
description: The comma separated ID list of permissions to include to result.
in: query
@@ -1691,6 +1844,12 @@ components:
name: fields
schema:
type: string
+ role_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
role_includeIds:
description: The comma separated ID list of roles to include to result.
in: query
@@ -1807,6 +1966,12 @@ components:
name: fields
schema:
type: string
+ site_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
site_includeIds:
description: The comma separated ID list of sites to include to result.
in: query
@@ -1914,6 +2079,12 @@ components:
name: fields
schema:
type: string
+ tag_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
tag_includeIds:
description: The comma separated ID list of tags to include to result.
in: query
@@ -2015,6 +2186,16 @@ components:
name: fields
schema:
type: string
+ template_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: type
+ in: query
+ name: filterKeys
+ schema:
+ default: type
+ type: string
template_includeIds:
description: The comma separated ID list of templates to include to result.
in: query
@@ -2041,6 +2222,15 @@ components:
schema:
default: 0
type: integer
+ template_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
template_search:
description: Search query.
in: query
@@ -2116,6 +2306,16 @@ components:
name: fields
schema:
type: string
+ templatemap_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: archiveType,buildType,isPreferred
+ in: query
+ name: filterKeys
+ schema:
+ default: 'archiveType,buildType,isPreferred'
+ type: string
templatemap_includeIds:
description: The comma separated ID list of templatemaps to include to result.
in: query
@@ -2213,6 +2413,16 @@ components:
name: fields
schema:
type: string
+ user_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status,lockout
+ in: query
+ name: filterKeys
+ schema:
+ default: 'status,lockout'
+ type: string
user_includeIds:
description: The comma separated ID list of users to include to result.
in: query
@@ -2314,6 +2524,12 @@ components:
name: fields
schema:
type: string
+ widget_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
widget_includeIds:
description: The comma separated ID list of widgets to include to result.
in: query
@@ -2415,6 +2631,12 @@ components:
name: fields
schema:
type: string
+ widgetset_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
widgetset_includeIds:
description: The comma separated ID list of widgetsets to include to result.
in: query
@@ -4845,7 +5067,7 @@ externalDocs:
url: https://www.movabletype.jp/developers/data-api/
info:
title: Movable Type Data API
- version: 8.6.0
+ version: 8.7.0
openapi: 3.0.0
paths:
/:
@@ -4977,8 +5199,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Upload file size is larger than CGIMaxUpload.
- security:
- - mtauth: []
summary: Upload a file
tags:
- Assets
@@ -5200,6 +5420,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/group_dateField'
- $ref: '#/components/parameters/group_dateFrom'
- $ref: '#/components/parameters/group_dateTo'
@@ -5233,8 +5454,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to retrieve the requested groups.
- security:
- - mtauth: []
summary: Retrieve a list of groups
tags:
- Groups
@@ -5268,8 +5487,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to create a group.
- security:
- - mtauth: []
summary: Create a new group
tags:
- Groups
@@ -5299,8 +5516,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to synchronize groups.
- security:
- - mtauth: []
summary: Synchronize groups
tags:
- Groups
@@ -5349,8 +5564,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a group
tags:
- Groups
@@ -5389,8 +5602,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve single group by its ID
tags:
- Groups
@@ -5446,8 +5657,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a group
tags:
- Groups
@@ -5466,6 +5675,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/user_dateField'
- $ref: '#/components/parameters/user_dateFrom'
- $ref: '#/components/parameters/user_dateTo'
@@ -5505,8 +5715,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve a list of members for specified group
tags:
- Groups
@@ -5555,8 +5763,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group or Member not found.
- security:
- - mtauth: []
tags:
- Groups
'/groups/{group_id}/members/{member_id}':
@@ -5609,8 +5815,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
tags:
- Groups
get:
@@ -5653,8 +5857,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group or Member not found.
- security:
- - mtauth: []
summary: Retrieve single member by its ID for specified group
tags:
- Groups
@@ -5675,6 +5877,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -5714,8 +5917,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for group
tags:
- Groups
@@ -5773,8 +5974,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Group not found
- security:
- - mtauth: []
summary: Grant permissions to group
tags:
- Groups
@@ -5832,8 +6031,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Group not found
- security:
- - mtauth: []
summary: Revoke permissions from group
tags:
- Groups
@@ -5850,6 +6047,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -5889,8 +6087,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions
tags:
- Permissions
@@ -5932,8 +6128,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of plugins in the specified site
tags:
- Plugins
@@ -5969,8 +6163,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Disable all plugins
tags:
- Plugins
@@ -6006,8 +6198,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Enable all plugins
tags:
- Plugins
@@ -6046,8 +6236,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found.
- security:
- - mtauth: []
summary: Retrieve single plugin by its ID
tags:
- Plugins
@@ -6089,8 +6277,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Disable a plugin
tags:
- Plugins
@@ -6132,8 +6318,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Enable a plugin
tags:
- Plugins
@@ -6196,8 +6380,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to publish content_data.
- security:
- - mtauth: []
summary: Publish Content Data
tags:
- Content Data
@@ -6275,8 +6457,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to publish.
- security:
- - mtauth: []
summary: Rebuild the static archives in relation to specified entries
tags:
- Entries
@@ -6378,8 +6558,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to retrieve the list of roles.
- security:
- - mtauth: []
summary: Retrieve a list of roles
tags:
- Roles
@@ -6419,8 +6597,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new role
tags:
- Roles
@@ -6469,8 +6645,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing role
tags:
- Roles
@@ -6509,8 +6683,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role not found.
- security:
- - mtauth: []
summary: Retrieve a single role by its ID
tags:
- Roles
@@ -6566,8 +6738,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing role
tags:
- Roles
@@ -6591,6 +6761,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -6630,8 +6801,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions by role
tags:
- Roles
@@ -6879,8 +7048,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new website
tags:
- Sites
@@ -6935,8 +7102,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing blog or website
tags:
- Sites
@@ -7035,8 +7200,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new blog
tags:
- Sites
@@ -7097,8 +7260,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing blog or website
tags:
- Sites
@@ -7119,6 +7280,7 @@ paths:
- $ref: '#/components/parameters/asset_searchFields'
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -7290,8 +7452,6 @@ paths:
type: object
type: object
description: Conflict
- security:
- - mtauth: []
summary: Upload a file
tags:
- Assets
@@ -7350,8 +7510,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an asset
tags:
- Assets
@@ -7465,8 +7623,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an asset
tags:
- Assets
@@ -7508,6 +7664,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -7589,6 +7746,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -7748,8 +7906,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Backup specified site
tags:
- Sites
@@ -7907,8 +8063,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new category
tags:
- Categories
@@ -7970,8 +8124,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Rearrange existing categories in a new order
tags:
- Categories
@@ -8031,8 +8183,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing category
tags:
- Categories
@@ -8146,8 +8296,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing category
tags:
- Categories
@@ -8270,6 +8418,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -8642,8 +8791,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new category set
tags:
- Category Sets
@@ -8700,8 +8847,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete category set
tags:
- Category Sets
@@ -8819,8 +8964,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update category set
tags:
- Category Sets
@@ -8859,6 +9002,11 @@ paths:
- 0
- 1
type: integer
+ - $ref: '#/components/parameters/category_limit'
+ - $ref: '#/components/parameters/category_offset'
+ - $ref: '#/components/parameters/category_searchFields'
+ - $ref: '#/components/parameters/category_sortBy'
+ - $ref: '#/components/parameters/category_sortOrder'
- $ref: '#/components/parameters/category_dateField'
- $ref: '#/components/parameters/category_dateFrom'
- $ref: '#/components/parameters/category_dateTo'
@@ -8957,8 +9105,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site pr Category_set not found.
- security:
- - mtauth: []
summary: Create a new category for category set
tags:
- Categories
@@ -9032,8 +9178,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Category_set not found.
- security:
- - mtauth: []
summary: Save hierarchical categories order in category set
tags:
- Categories
@@ -9098,8 +9242,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete single category in category set
tags:
- Categories
@@ -9230,8 +9372,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update single category in category set
tags:
- Categories
@@ -9630,6 +9770,10 @@ paths:
- Future
- Spam
type: string
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -9725,8 +9869,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a comment
tags:
- Comments
@@ -9841,8 +9983,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a comment
tags:
- Comments
@@ -9862,6 +10002,7 @@ paths:
type: integer
- $ref: '#/components/parameters/content_type_limit'
- $ref: '#/components/parameters/content_type_offset'
+ - $ref: '#/components/parameters/content_type_searchFields'
- description: |
The field name for sort. You can specify one of following values.
- name
@@ -9918,8 +10059,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Content Type Collection
tags:
- Content Types
@@ -9975,8 +10114,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create Content Type
tags:
- Content Types
@@ -10035,8 +10172,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete Content Type
tags:
- Content Types
@@ -10086,8 +10221,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Fetch single Content Type
tags:
- Content Types
@@ -10153,8 +10286,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update Content Type
tags:
- Content Types
@@ -10245,6 +10376,8 @@ paths:
- $ref: '#/components/parameters/content_data_fields'
- $ref: '#/components/parameters/content_data_includeIds'
- $ref: '#/components/parameters/content_data_excludeIds'
+ - $ref: '#/components/parameters/content_data_filterKeys'
+ - $ref: '#/components/parameters/content_data_searchFields'
- $ref: '#/components/parameters/content_data_dateField'
- $ref: '#/components/parameters/content_data_dateFrom'
- $ref: '#/components/parameters/content_data_dateTo'
@@ -10313,6 +10446,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/content_data_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -10348,8 +10482,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Create Content Data
tags:
- Content Types
@@ -10433,8 +10565,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found
- security:
- - mtauth: []
summary: Make a preview by data
tags:
- Content Types
@@ -10501,8 +10631,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete single content data
tags:
- Content Types
@@ -10599,6 +10727,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/content_data_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -10640,8 +10769,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update Content Data
tags:
- Content Types
@@ -10730,8 +10857,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type or Content_data not found
- security:
- - mtauth: []
summary: Make a preview by id
tags:
- Content Types
@@ -10757,6 +10882,7 @@ paths:
type: integer
- $ref: '#/components/parameters/content_field_limit'
- $ref: '#/components/parameters/content_field_offset'
+ - $ref: '#/components/parameters/content_field_searchFields'
- description: |
The field name for sort. You can specify one of following values.
- name
@@ -10813,8 +10939,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Content Field Collection
tags:
- Content Fields
@@ -10876,8 +11000,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Create Content Field
tags:
- Content Types
@@ -10950,8 +11072,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Save hierarchical content field order
tags:
- Content Types
@@ -11016,8 +11136,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete Content Field
tags:
- Content Types
@@ -11073,8 +11191,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type or Content_field not found.
- security:
- - mtauth: []
summary: Fetch single Content Field
tags:
- Content Types
@@ -11148,8 +11264,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update Content Field
tags:
- Content Types
@@ -11297,6 +11411,7 @@ paths:
name: fields
schema:
type: string
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -11356,6 +11471,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/entry_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -11397,8 +11513,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new entry
tags:
- Entries
@@ -11437,8 +11551,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Export entries
tags:
- Entries
@@ -11521,8 +11633,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Import entries
tags:
- Entries
@@ -11590,8 +11700,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Entry not found
- security:
- - mtauth: []
summary: Make a preview for a entry
tags:
- Entries
@@ -11649,8 +11757,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an entry
tags:
- Entries
@@ -11746,6 +11852,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/entry_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -11793,8 +11900,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an entry
tags:
- Entries
@@ -11848,6 +11953,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_sortOrder'
- $ref: '#/components/parameters/asset_fields'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- $ref: '#/components/parameters/asset_dateField'
- $ref: '#/components/parameters/asset_dateFrom'
- $ref: '#/components/parameters/asset_dateTo'
@@ -12053,6 +12160,10 @@ paths:
name: offset
schema:
type: integer
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -12147,8 +12258,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Create a new comment on an entry
tags:
- Comments
@@ -12210,8 +12319,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Reply to specified comment
tags:
- Comments
@@ -12286,8 +12393,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Entry not found
- security:
- - mtauth: []
summary: Make a preview for a entry with existing data
tags:
- Entries
@@ -12336,8 +12441,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found
- security:
- - mtauth: []
summary: Export site's theme
tags:
- Themes
@@ -12356,6 +12459,7 @@ paths:
- $ref: '#/components/parameters/field_sortBy'
- $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/field_fields'
+ - $ref: '#/components/parameters/field_filterKeys'
- $ref: '#/components/parameters/field_dateField'
- $ref: '#/components/parameters/field_dateFrom'
- $ref: '#/components/parameters/field_dateTo'
@@ -12395,8 +12499,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of fields in the specified site
tags:
- CustomFields
@@ -12442,8 +12544,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new field
tags:
- CustomFields
@@ -12497,8 +12597,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a field
tags:
- CustomFields
@@ -12542,8 +12640,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Field not found.
- security:
- - mtauth: []
summary: Retrieve single field by its ID
tags:
- CustomFields
@@ -12604,8 +12700,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a field
tags:
- CustomFields
@@ -12758,8 +12852,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new folder.
tags:
- Folders
@@ -12821,8 +12913,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Rearrange existing folders in a new order
tags:
- Folders
@@ -12882,8 +12972,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing folder
tags:
- Folders
@@ -12997,8 +13085,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing folder
tags:
- Folders
@@ -13116,6 +13202,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -13397,8 +13484,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of formatted_texts in the specified site
tags:
- FormattedText
@@ -13444,8 +13529,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new formatted_text
tags:
- FormattedText
@@ -13499,8 +13582,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a formatted_text
tags:
- FormattedText
@@ -13544,8 +13625,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or FormattedText not found.
- security:
- - mtauth: []
summary: Retrieve single formatted_text by its ID
tags:
- FormattedText
@@ -13606,8 +13685,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a formatted_text
tags:
- FormattedText
@@ -13659,8 +13736,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Reset logs
tags:
- Logs
@@ -13682,6 +13757,7 @@ paths:
- $ref: '#/components/parameters/log_searchFields'
- $ref: '#/components/parameters/log_limit'
- $ref: '#/components/parameters/log_offset'
+ - $ref: '#/components/parameters/log_filterKeys'
- description: |
- id
- created_on
@@ -13772,8 +13848,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of logs in the specified site
tags:
- Logs
@@ -13819,8 +13893,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new log
tags:
- Logs
@@ -13863,8 +13935,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Export logs
tags:
- Logs
@@ -13918,8 +13988,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing log
tags:
- Logs
@@ -13963,8 +14031,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Log not found.
- security:
- - mtauth: []
summary: Retrieve a single log by its ID
tags:
- Logs
@@ -14025,8 +14091,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing log
tags:
- Logs
@@ -14063,6 +14127,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -14122,6 +14187,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/page_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -14163,8 +14229,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new page
tags:
- Pages
@@ -14232,8 +14296,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Page not found
- security:
- - mtauth: []
summary: Make a preview for a page
tags:
- Pages
@@ -14292,8 +14354,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing page
tags:
- Pages
@@ -14371,6 +14431,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/page_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -14418,8 +14479,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing page
tags:
- Pages
@@ -14443,6 +14502,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -14546,6 +14607,10 @@ paths:
name: offset
schema:
type: integer
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -14640,8 +14705,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Create a new comment on a page
tags:
- Comments
@@ -14703,8 +14766,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Reply to specified comment
tags:
- Comments
@@ -14779,8 +14840,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Page not found
- security:
- - mtauth: []
summary: Make a preview for a page with existing data
tags:
- Pages
@@ -14844,8 +14903,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for site
tags:
- Sites
@@ -14903,8 +14960,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Grant permissions to site
tags:
- Sites
@@ -14962,8 +15017,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Revoke permissions from site
tags:
- Sites
@@ -15032,8 +15085,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Reset all templates in the site
tags:
- Templates
@@ -15049,14 +15100,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -15078,7 +15129,7 @@ paths:
name: path
schema:
type: string
- - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
+ - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
in: query
name: uniquePath
schema:
@@ -15126,8 +15177,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve pageviews count for each date from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -15143,14 +15192,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -15212,8 +15261,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve visits count for each date from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -15229,14 +15276,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -15258,7 +15305,7 @@ paths:
name: path
schema:
type: string
- - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
+ - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
in: query
name: uniquePath
schema:
@@ -15306,8 +15353,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve pageviews count for each path from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -15323,14 +15368,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -15392,8 +15437,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve visits count for each path from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -15437,8 +15480,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve a current effective provider
tags:
- Statistics
@@ -15549,8 +15590,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing tag
tags:
- Tags
@@ -15654,8 +15693,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing tag
tags:
- Tags
@@ -15679,6 +15716,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -15788,6 +15827,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -15869,6 +15909,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -15930,6 +15971,7 @@ paths:
- $ref: '#/components/parameters/template_searchFields'
- $ref: '#/components/parameters/template_limit'
- $ref: '#/components/parameters/template_offset'
+ - $ref: '#/components/parameters/template_filterKeys'
- description: |
#### id
@@ -16021,8 +16063,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of templates in the specified site
tags:
- Templates
@@ -16039,6 +16079,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/template_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -16074,8 +16115,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new template
tags:
- Templates
@@ -16144,8 +16183,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Make a preview for a template
tags:
- Templates
@@ -16204,8 +16241,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a template
tags:
- Templates
@@ -16255,8 +16290,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Retrieve single template by its ID
tags:
- Templates
@@ -16281,6 +16314,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/template_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -16322,8 +16356,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a template
tags:
- Templates
@@ -16376,8 +16408,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Make a clone of a template
tags:
- Templates
@@ -16457,8 +16487,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Make a preview for a template with existing data
tags:
- Templates
@@ -16517,8 +16545,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Publish a template
tags:
- Templates
@@ -16575,8 +16601,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Reset template text to theme default or tempalte_set default
tags:
- Templates
@@ -16602,6 +16626,7 @@ paths:
- $ref: '#/components/parameters/templatemap_fields'
- $ref: '#/components/parameters/templatemap_includeIds'
- $ref: '#/components/parameters/templatemap_excludeIds'
+ - $ref: '#/components/parameters/templatemap_filterKeys'
- $ref: '#/components/parameters/templatemap_dateField'
- $ref: '#/components/parameters/templatemap_dateFrom'
- $ref: '#/components/parameters/templatemap_dateTo'
@@ -16641,8 +16666,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Retrieve a list of templatemaps in the specified site
tags:
- Templates
@@ -16694,8 +16717,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Create a new templatemap
tags:
- Templates
@@ -16755,8 +16776,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing templatemap
tags:
- Templates
@@ -16805,8 +16824,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template or TemplateMap not found.
- security:
- - mtauth: []
summary: Retrieve a single templatemap by its ID
tags:
- Templates
@@ -16873,8 +16890,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing templatemap
tags:
- Templates
@@ -16929,8 +16944,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of themes for site
tags:
- Themes
@@ -16980,8 +16993,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found.
- security:
- - mtauth: []
summary: Retrieve a single theme by its ID for site
tags:
- Themes
@@ -17034,8 +17045,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found
- security:
- - mtauth: []
summary: Apply a theme to site
tags:
- Themes
@@ -17095,8 +17104,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgets in the specified site
tags:
- Widgets
@@ -17142,8 +17149,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new widget
tags:
- Widgets
@@ -17197,8 +17202,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a widget
tags:
- Widgets
@@ -17242,8 +17245,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found.
- security:
- - mtauth: []
summary: Retrieve a single widget by its ID
tags:
- Widgets
@@ -17304,8 +17305,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a widget
tags:
- Widgets
@@ -17352,8 +17351,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found
- security:
- - mtauth: []
summary: Make a clone of a widget
tags:
- Widgets
@@ -17404,8 +17401,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found
- security:
- - mtauth: []
summary: Reset widget text to default
tags:
- Widgets
@@ -17465,8 +17460,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgetsets in the specified site
tags:
- WidgetSets
@@ -17512,8 +17505,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new widgetset
tags:
- WidgetSets
@@ -17567,8 +17558,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing widgetset
tags:
- WidgetSets
@@ -17612,8 +17601,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or WidgetSet not found.
- security:
- - mtauth: []
summary: Retrieve a single widgetset by its ID
tags:
- WidgetSets
@@ -17674,8 +17661,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing widgetset
tags:
- WidgetSets
@@ -17740,8 +17725,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or WidgetSet not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgets in the specified widgetset
tags:
- Widgets
@@ -17792,8 +17775,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found.
- security:
- - mtauth: []
summary: Retrieve a single widget by widgetset ID
tags:
- Widgets
@@ -17842,8 +17823,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of themes
tags:
- Themes
@@ -17898,8 +17877,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Uninstall a specified theme from the MT
tags:
- Themes
@@ -17943,8 +17920,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found.
- security:
- - mtauth: []
summary: Retrieve a single theme by its ID
tags:
- Themes
@@ -17986,8 +17961,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Invalidate current session. This is like logout
tags:
- Authentication
@@ -18064,6 +18037,7 @@ paths:
- $ref: '#/components/parameters/user_searchFields'
- $ref: '#/components/parameters/user_limit'
- $ref: '#/components/parameters/user_offset'
+ - $ref: '#/components/parameters/user_filterKeys'
- description: |
The field name for sort. You can specify one of following values
- id
@@ -18205,8 +18179,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new user
tags:
- Users
@@ -18233,8 +18205,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to export users.
- security:
- - mtauth: []
summary: Export users
tags:
- Users
@@ -18279,8 +18249,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to import users.
- security:
- - mtauth: []
summary: Import users
tags:
- Users
@@ -18310,8 +18278,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to synchronize users.
- security:
- - mtauth: []
summary: Synchronize users
tags:
- Users
@@ -18366,8 +18332,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete user
tags:
- Users
@@ -18477,8 +18441,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update user data
tags:
- Users
@@ -18497,6 +18459,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/group_dateField'
- $ref: '#/components/parameters/group_dateFrom'
- $ref: '#/components/parameters/group_dateTo'
@@ -18536,8 +18499,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: User not found.
- security:
- - mtauth: []
summary: Retrieve a list of groups
tags:
- Users
@@ -18559,6 +18520,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -18598,8 +18560,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for user
tags:
- Users
@@ -18657,8 +18617,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Grant permissions to user
tags:
- Users
@@ -18716,8 +18674,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Revoke permissions from user
tags:
- Users
@@ -18768,8 +18724,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found
- security:
- - mtauth: []
summary: Send the link for password recovery to specified user by email
tags:
- Users
@@ -18933,8 +18887,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found
- security:
- - mtauth: []
summary: Unlock user account
tags:
- Users
@@ -18975,6 +18927,8 @@ paths:
summary: Get server API version
tags:
- Common API
+security:
+ - mtauth: []
servers:
- url: https://example.com/mt/mt-data-api.cgi/v4
tags:
diff --git a/src/openapi/v5.json b/src/openapi/v5.json
index acff681..df9ace0 100644
--- a/src/openapi/v5.json
+++ b/src/openapi/v5.json
@@ -42,6 +42,15 @@
"type": "string"
}
},
+ "asset_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: class",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "class",
+ "type": "string"
+ }
+ },
"asset_includeIds": {
"description": "The comma separated ID list of assets to include to result.",
"in": "query",
@@ -148,6 +157,14 @@
"type": "string"
}
},
+ "category_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"category_includeIds": {
"description": "The comma separated ID list of categories to include to result.",
"in": "query",
@@ -232,6 +249,14 @@
"type": "string"
}
},
+ "category_set_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"category_set_includeIds": {
"description": "The comma separated ID list of category_sets to include to result.",
"in": "query",
@@ -360,6 +385,15 @@
"type": "string"
}
},
+ "comment_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"comment_includeIds": {
"description": "The comma separated ID list of comments to include to result.",
"in": "query",
@@ -466,6 +500,15 @@
"type": "string"
}
},
+ "content_data_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"content_data_includeIds": {
"description": "The comma separated ID list of content_data to include to result.",
"in": "query",
@@ -492,6 +535,18 @@
"type": "integer"
}
},
+ "content_data_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"content_data_search": {
"description": "Search query.",
"in": "query",
@@ -572,6 +627,14 @@
"type": "string"
}
},
+ "content_field_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"content_field_includeIds": {
"description": "The comma separated ID list of content_fields to include to result.",
"in": "query",
@@ -678,6 +741,14 @@
"type": "string"
}
},
+ "content_type_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"content_type_includeIds": {
"description": "The comma separated ID list of content_types to include to result.",
"in": "query",
@@ -784,6 +855,15 @@
"type": "string"
}
},
+ "entry_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"entry_includeIds": {
"description": "The comma separated ID list of entries to include to result.",
"in": "query",
@@ -838,6 +918,18 @@
"type": "integer"
}
},
+ "entry_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"entry_search": {
"description": "Search query.",
"in": "query",
@@ -940,6 +1032,15 @@
"type": "string"
}
},
+ "field_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: systemObject,type",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "systemObject,type",
+ "type": "string"
+ }
+ },
"field_includeIds": {
"description": "The comma separated ID list of fields to include to result.",
"in": "query",
@@ -1046,6 +1147,14 @@
"type": "string"
}
},
+ "folder_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"folder_includeIds": {
"description": "The comma separated ID list of folders to include to result.",
"in": "query",
@@ -1152,6 +1261,14 @@
"type": "string"
}
},
+ "formatted_text_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"formatted_text_includeIds": {
"description": "The comma separated ID list of formatted_texts to include to result.",
"in": "query",
@@ -1258,6 +1375,15 @@
"type": "string"
}
},
+ "group_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"group_includeIds": {
"description": "The comma separated ID list of groups to include to result.",
"in": "query",
@@ -1364,6 +1490,15 @@
"type": "string"
}
},
+ "log_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: level",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "level",
+ "type": "string"
+ }
+ },
"log_includeIds": {
"description": "The comma separated ID list of logs to include to result.",
"in": "query",
@@ -1470,6 +1605,15 @@
"type": "string"
}
},
+ "page_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"page_includeIds": {
"description": "The comma separated ID list of pages to include to result.",
"in": "query",
@@ -1524,6 +1668,18 @@
"type": "integer"
}
},
+ "page_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"page_search": {
"description": "Search query.",
"in": "query",
@@ -1634,6 +1790,15 @@
"type": "string"
}
},
+ "permission_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: blogIds",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "blogIds",
+ "type": "string"
+ }
+ },
"permission_includeIds": {
"description": "The comma separated ID list of permissions to include to result.",
"in": "query",
@@ -1746,6 +1911,14 @@
"type": "string"
}
},
+ "role_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"role_includeIds": {
"description": "The comma separated ID list of roles to include to result.",
"in": "query",
@@ -1859,6 +2032,14 @@
"type": "string"
}
},
+ "site_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"site_includeIds": {
"description": "The comma separated ID list of sites to include to result.",
"in": "query",
@@ -1968,6 +2149,14 @@
"type": "string"
}
},
+ "tag_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"tag_includeIds": {
"description": "The comma separated ID list of tags to include to result.",
"in": "query",
@@ -2074,6 +2263,15 @@
"type": "string"
}
},
+ "template_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: type",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "type",
+ "type": "string"
+ }
+ },
"template_includeIds": {
"description": "The comma separated ID list of templates to include to result.",
"in": "query",
@@ -2100,6 +2298,18 @@
"type": "integer"
}
},
+ "template_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"template_search": {
"description": "Search query.",
"in": "query",
@@ -2180,6 +2390,15 @@
"type": "string"
}
},
+ "templatemap_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: archiveType,buildType,isPreferred",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "archiveType,buildType,isPreferred",
+ "type": "string"
+ }
+ },
"templatemap_includeIds": {
"description": "The comma separated ID list of templatemaps to include to result.",
"in": "query",
@@ -2285,6 +2504,15 @@
"type": "string"
}
},
+ "user_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status,lockout",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status,lockout",
+ "type": "string"
+ }
+ },
"user_includeIds": {
"description": "The comma separated ID list of users to include to result.",
"in": "query",
@@ -2391,6 +2619,14 @@
"type": "string"
}
},
+ "widget_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"widget_includeIds": {
"description": "The comma separated ID list of widgets to include to result.",
"in": "query",
@@ -2497,6 +2733,14 @@
"type": "string"
}
},
+ "widgetset_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"widgetset_includeIds": {
"description": "The comma separated ID list of widgetsets to include to result.",
"in": "query",
@@ -6178,7 +6422,7 @@
},
"info": {
"title": "Movable Type Data API",
- "version": "8.6.0"
+ "version": "8.7.0"
},
"openapi": "3.0.0",
"paths": {
@@ -6382,11 +6626,6 @@
"description": "Upload file size is larger than CGIMaxUpload."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Upload a file",
"tags": [
"Assets"
@@ -6726,6 +6965,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/group_dateField"
},
@@ -6784,11 +7026,6 @@
"description": "Do not have permission to retrieve the requested groups."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of groups",
"tags": [
"Groups"
@@ -6844,11 +7081,6 @@
"description": "Do not have permission to create a group."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new group",
"tags": [
"Groups"
@@ -6897,11 +7129,6 @@
"description": "Do not have permission to synchronize groups."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Synchronize groups",
"tags": [
"Groups"
@@ -6976,11 +7203,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a group",
"tags": [
"Groups"
@@ -7045,11 +7267,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single group by its ID",
"tags": [
"Groups"
@@ -7136,11 +7353,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a group",
"tags": [
"Groups"
@@ -7179,6 +7391,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/user_dateField"
},
@@ -7247,11 +7462,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of members for specified group",
"tags": [
"Groups"
@@ -7332,11 +7542,6 @@
"description": "Group or Member not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"tags": [
"Groups"
]
@@ -7418,11 +7623,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"tags": [
"Groups"
]
@@ -7494,11 +7694,6 @@
"description": "Group or Member not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single member by its ID for specified group",
"tags": [
"Groups"
@@ -7535,6 +7730,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -7603,11 +7801,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for group",
"tags": [
"Groups",
@@ -7697,11 +7890,6 @@
"description": "Site or Group not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to group",
"tags": [
"Groups",
@@ -7791,11 +7979,6 @@
"description": "Site or Group not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from group",
"tags": [
"Groups",
@@ -7825,6 +8008,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -7893,11 +8079,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions",
"tags": [
"Permissions"
@@ -7964,11 +8145,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of plugins in the specified site",
"tags": [
"Plugins"
@@ -8027,11 +8203,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Disable all plugins",
"tags": [
"Plugins"
@@ -8090,11 +8261,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Enable all plugins",
"tags": [
"Plugins"
@@ -8158,11 +8324,6 @@
"description": "Site or Plugin not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single plugin by its ID",
"tags": [
"Plugins"
@@ -8231,11 +8392,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Disable a plugin",
"tags": [
"Plugins"
@@ -8304,11 +8460,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Enable a plugin",
"tags": [
"Plugins"
@@ -8401,11 +8552,6 @@
"description": "Do not have permission to publish content_data."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Publish Content Data",
"tags": [
"Content Data",
@@ -8504,11 +8650,6 @@
"description": "Do not have permission to publish."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rebuild the static archives in relation to specified entries",
"tags": [
"Entries",
@@ -8676,11 +8817,6 @@
"description": "Do not have permission to retrieve the list of roles."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of roles",
"tags": [
"Roles"
@@ -8746,11 +8882,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new role",
"tags": [
"Roles"
@@ -8825,11 +8956,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing role",
"tags": [
"Roles"
@@ -8894,11 +9020,6 @@
"description": "Site or Role not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single role by its ID",
"tags": [
"Roles"
@@ -8985,11 +9106,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing role",
"tags": [
"Roles"
@@ -9026,6 +9142,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -9094,11 +9213,6 @@
"description": "Site or Role not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions by role",
"tags": [
"Roles",
@@ -9432,11 +9546,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new website",
"tags": [
"Sites"
@@ -9511,11 +9620,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing blog or website",
"tags": [
"Sites"
@@ -9669,11 +9773,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new blog",
"tags": [
"Sites"
@@ -9760,11 +9859,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing blog or website",
"tags": [
"Sites"
@@ -9802,6 +9896,9 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -10047,11 +10144,6 @@
"description": "Conflict"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Upload a file",
"tags": [
"Assets"
@@ -10134,11 +10226,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an asset",
"tags": [
"Assets"
@@ -10313,11 +10400,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an asset",
"tags": [
"Assets"
@@ -10391,6 +10473,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -10533,6 +10618,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -10795,11 +10883,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Backup specified site",
"tags": [
"Sites",
@@ -11021,11 +11104,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new category",
"tags": [
"Categories"
@@ -11109,11 +11187,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rearrange existing categories in a new order",
"tags": [
"Categories"
@@ -11196,11 +11269,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing category",
"tags": [
"Categories"
@@ -11375,11 +11443,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing category",
"tags": [
"Categories"
@@ -11564,6 +11627,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -12104,11 +12170,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new category set",
"tags": [
"Category Sets"
@@ -12191,11 +12252,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete category set",
"tags": [
"Category Sets"
@@ -12371,11 +12427,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update category set",
"tags": [
"Category Sets"
@@ -12431,6 +12482,21 @@
"type": "integer"
}
},
+ {
+ "$ref": "#/components/parameters/category_limit"
+ },
+ {
+ "$ref": "#/components/parameters/category_offset"
+ },
+ {
+ "$ref": "#/components/parameters/category_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/category_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/category_sortOrder"
+ },
{
"$ref": "#/components/parameters/category_dateField"
},
@@ -12582,11 +12648,6 @@
"description": "Site pr Category_set not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new category for category set",
"tags": [
"Categories",
@@ -12679,11 +12740,6 @@
"description": "Site or Category_set not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Save hierarchical categories order in category set",
"tags": [
"Categories",
@@ -12775,11 +12831,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete single category in category set",
"tags": [
"Categories",
@@ -12973,11 +13024,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update single category in category set",
"tags": [
"Categories",
@@ -13589,6 +13635,18 @@
"type": "string"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -13739,11 +13797,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a comment",
"tags": [
"Comments"
@@ -13916,11 +13969,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a comment",
"tags": [
"Comments"
@@ -13945,6 +13993,9 @@
{
"$ref": "#/components/parameters/content_type_offset"
},
+ {
+ "$ref": "#/components/parameters/content_type_searchFields"
+ },
{
"description": "The field name for sort. You can specify one of following values.\n- name\n- dataLabel\n- uniqueID\n- modified_on\n",
"in": "query",
@@ -14037,11 +14088,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Content Type Collection",
"tags": [
"Content Types"
@@ -14118,11 +14164,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create Content Type",
"tags": [
"Content Types"
@@ -14205,11 +14246,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete Content Type",
"tags": [
"Content Types"
@@ -14283,11 +14319,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Fetch single Content Type",
"tags": [
"Content Types"
@@ -14382,11 +14413,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update Content Type",
"tags": [
"Content Types"
@@ -14427,6 +14453,12 @@
{
"$ref": "#/components/parameters/content_data_offset"
},
+ {
+ "$ref": "#/components/parameters/content_data_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/content_data_searchFields"
+ },
{
"description": "The field name for sort. You can specify one of following values.\n- id\n- uniqueID\n- authored_on\n- created_on\n- modified_on\n",
"in": "query",
@@ -14548,6 +14580,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/content_data_saveRevision"
}
],
"requestBody": {
@@ -14609,11 +14644,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create Content Data",
"tags": [
"Content Types",
@@ -14722,11 +14752,6 @@
"description": "Site or Content_type not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview by data",
"tags": [
"Content Types",
@@ -14818,11 +14843,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete single content data",
"tags": [
"Content Types",
@@ -14945,6 +14965,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/content_data_saveRevision"
}
],
"requestBody": {
@@ -15016,11 +15039,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update Content Data",
"tags": [
"Content Types",
@@ -15137,11 +15155,6 @@
"description": "Site or Content_type or Content_data not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview by id",
"tags": [
"Content Types",
@@ -15175,6 +15188,9 @@
{
"$ref": "#/components/parameters/content_field_offset"
},
+ {
+ "$ref": "#/components/parameters/content_field_searchFields"
+ },
{
"description": "The field name for sort. You can specify one of following values.\n- name\n- dataLabel\n- uniqueID\n- modified_on\n",
"in": "query",
@@ -15267,11 +15283,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Content Field Collection",
"tags": [
"Content Fields",
@@ -15357,11 +15368,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create Content Field",
"tags": [
"Content Types",
@@ -15454,11 +15460,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Save hierarchical content field order",
"tags": [
"Content Types",
@@ -15550,11 +15551,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete Content Field",
"tags": [
"Content Types",
@@ -15637,11 +15633,6 @@
"description": "Site or Content_type or Content_field not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Fetch single Content Field",
"tags": [
"Content Types",
@@ -15745,11 +15736,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update Content Field",
"tags": [
"Content Types",
@@ -15816,6 +15802,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -15899,6 +15888,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_saveRevision"
}
],
"requestBody": {
@@ -15968,11 +15960,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new entry",
"tags": [
"Entries"
@@ -16036,11 +16023,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export entries",
"tags": [
"Entries"
@@ -16156,11 +16138,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Import entries",
"tags": [
"Entries"
@@ -16260,11 +16237,6 @@
"description": "Site or Entry not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a entry",
"tags": [
"Entries"
@@ -16347,11 +16319,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an entry",
"tags": [
"Entries"
@@ -16477,6 +16444,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_saveRevision"
}
],
"requestBody": {
@@ -16556,11 +16526,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an entry",
"tags": [
"Entries"
@@ -16628,6 +16593,12 @@
{
"$ref": "#/components/parameters/asset_fields"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"$ref": "#/components/parameters/asset_dateField"
},
@@ -16910,6 +16881,18 @@
"type": "integer"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -17063,11 +17046,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new comment on an entry",
"tags": [
"Comments",
@@ -17163,11 +17141,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reply to specified comment",
"tags": [
"Comments",
@@ -17276,11 +17249,6 @@
"description": "Site or Entry not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a entry with existing data",
"tags": [
"Entries"
@@ -17350,11 +17318,6 @@
"description": "Site or Theme not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export site's theme",
"tags": [
"Themes"
@@ -17393,6 +17356,9 @@
{
"$ref": "#/components/parameters/field_fields"
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
{
"$ref": "#/components/parameters/field_dateField"
},
@@ -17461,11 +17427,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of fields in the specified site",
"tags": [
"CustomFields"
@@ -17541,11 +17502,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new field",
"tags": [
"CustomFields"
@@ -17628,11 +17584,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a field",
"tags": [
"CustomFields"
@@ -17705,11 +17656,6 @@
"description": "Site or Field not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single field by its ID",
"tags": [
"CustomFields"
@@ -17804,11 +17750,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a field",
"tags": [
"CustomFields"
@@ -18020,11 +17961,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new folder.",
"tags": [
"Folders"
@@ -18108,11 +18044,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rearrange existing folders in a new order",
"tags": [
"Folders"
@@ -18195,11 +18126,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing folder",
"tags": [
"Folders"
@@ -18374,11 +18300,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing folder",
"tags": [
"Folders"
@@ -18554,6 +18475,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -18980,11 +18904,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of formatted_texts in the specified site",
"tags": [
"FormattedText"
@@ -19060,11 +18979,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new formatted_text",
"tags": [
"FormattedText"
@@ -19147,11 +19061,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a formatted_text",
"tags": [
"FormattedText"
@@ -19224,11 +19133,6 @@
"description": "Site or FormattedText not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single formatted_text by its ID",
"tags": [
"FormattedText"
@@ -19323,11 +19227,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a formatted_text",
"tags": [
"FormattedText"
@@ -19407,11 +19306,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset logs",
"tags": [
"Logs"
@@ -19440,6 +19334,9 @@
{
"$ref": "#/components/parameters/log_offset"
},
+ {
+ "$ref": "#/components/parameters/log_filterKeys"
+ },
{
"description": "- id\n- created_on\n- blog_id\n- author_id\n- level\n- class\n\n**Default**: created_on\n",
"in": "query",
@@ -19556,11 +19453,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of logs in the specified site",
"tags": [
"Logs"
@@ -19636,11 +19528,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new log",
"tags": [
"Logs"
@@ -19711,11 +19598,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export logs",
"tags": [
"Logs"
@@ -19798,11 +19680,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing log",
"tags": [
"Logs"
@@ -19875,11 +19752,6 @@
"description": "Site or Log not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single log by its ID",
"tags": [
"Logs"
@@ -19974,11 +19846,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing log",
"tags": [
"Logs"
@@ -20044,6 +19911,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -20127,6 +19997,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/page_saveRevision"
}
],
"requestBody": {
@@ -20196,11 +20069,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new page",
"tags": [
"Pages"
@@ -20300,11 +20168,6 @@
"description": "Site or Page not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a page",
"tags": [
"Pages"
@@ -20387,11 +20250,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing page",
"tags": [
"Pages"
@@ -20496,6 +20354,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/page_saveRevision"
}
],
"requestBody": {
@@ -20575,11 +20436,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing page",
"tags": [
"Pages"
@@ -20619,6 +20475,12 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -20764,6 +20626,18 @@
"type": "integer"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -20917,11 +20791,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new comment on a page",
"tags": [
"Comments",
@@ -21017,11 +20886,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reply to specified comment",
"tags": [
"Comments",
@@ -21130,11 +20994,6 @@
"description": "Site or Page not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a page with existing data",
"tags": [
"Pages"
@@ -21236,11 +21095,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for site",
"tags": [
"Sites",
@@ -21330,11 +21184,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to site",
"tags": [
"Sites",
@@ -21424,11 +21273,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from site",
"tags": [
"Sites",
@@ -21512,11 +21356,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset all templates in the site",
"tags": [
"Templates"
@@ -21536,7 +21375,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -21546,7 +21385,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -21580,7 +21419,7 @@
}
},
{
- "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
"in": "query",
"name": "uniquePath",
"schema": {
@@ -21656,11 +21495,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve pageviews count for each date from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -21680,7 +21514,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -21690,7 +21524,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -21788,11 +21622,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve visits count for each date from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -21812,7 +21641,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -21822,7 +21651,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -21856,7 +21685,7 @@
}
},
{
- "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
"in": "query",
"name": "uniquePath",
"schema": {
@@ -21932,11 +21761,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve pageviews count for each path from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -21956,7 +21780,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -21966,7 +21790,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -22064,11 +21888,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve visits count for each path from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -22135,11 +21954,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a current effective provider",
"tags": [
"Statistics"
@@ -22328,11 +22142,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing tag",
"tags": [
"Tags"
@@ -22499,11 +22308,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing tag",
"tags": [
"Tags"
@@ -22543,6 +22347,12 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -22711,6 +22521,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -22853,6 +22666,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -22952,6 +22768,9 @@
{
"$ref": "#/components/parameters/template_offset"
},
+ {
+ "$ref": "#/components/parameters/template_filterKeys"
+ },
{
"description": "#### id\n\nSort by the ID of each template.\n\n#### name\n\nSort by the name of each template.\n\n#### created_on\n\nSort by the created time of each template.\n\n#### modified_on\n\nSort by the modified time of each template.\n\n#### created_by\n\nSort by the ID of user who created each template.\n\n#### modified_by\n\nSort by the ID of user who modified each template.\n\n#### type\n\nSort by the type of each template.\n\n**Default**: name\n",
"in": "query",
@@ -23058,11 +22877,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of templates in the specified site",
"tags": [
"Templates"
@@ -23078,6 +22892,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/template_saveRevision"
}
],
"requestBody": {
@@ -23139,11 +22956,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new template",
"tags": [
"Templates"
@@ -23243,11 +23055,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a template",
"tags": [
"Templates"
@@ -23330,11 +23137,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a template",
"tags": [
"Templates"
@@ -23408,11 +23210,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single template by its ID",
"tags": [
"Templates"
@@ -23436,6 +23233,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/template_saveRevision"
}
],
"requestBody": {
@@ -23507,11 +23307,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a template",
"tags": [
"Templates"
@@ -23589,11 +23384,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a clone of a template",
"tags": [
"Templates"
@@ -23701,11 +23491,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a template with existing data",
"tags": [
"Templates"
@@ -23783,11 +23568,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Publish a template",
"tags": [
"Templates"
@@ -23871,11 +23651,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset template text to theme default or tempalte_set default",
"tags": [
"Templates"
@@ -23928,6 +23703,9 @@
{
"$ref": "#/components/parameters/templatemap_excludeIds"
},
+ {
+ "$ref": "#/components/parameters/templatemap_filterKeys"
+ },
{
"$ref": "#/components/parameters/templatemap_dateField"
},
@@ -23996,11 +23774,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of templatemaps in the specified site",
"tags": [
"Templates",
@@ -24085,11 +23858,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new templatemap",
"tags": [
"Templates",
@@ -24181,11 +23949,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing templatemap",
"tags": [
"Templates",
@@ -24264,11 +24027,6 @@
"description": "Site or Template or TemplateMap not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single templatemap by its ID",
"tags": [
"Templates",
@@ -24372,11 +24130,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing templatemap",
"tags": [
"Templates",
@@ -24455,11 +24208,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of themes for site",
"tags": [
"Themes"
@@ -24532,11 +24280,6 @@
"description": "Site or Theme not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single theme by its ID for site",
"tags": [
"Themes"
@@ -24614,11 +24357,6 @@
"description": "Site or Theme not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Apply a theme to site",
"tags": [
"Themes"
@@ -24731,11 +24469,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgets in the specified site",
"tags": [
"Widgets"
@@ -24811,11 +24544,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new widget",
"tags": [
"Widgets"
@@ -24898,11 +24626,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a widget",
"tags": [
"Widgets"
@@ -24975,11 +24698,6 @@
"description": "Site or Widget not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widget by its ID",
"tags": [
"Widgets"
@@ -25074,11 +24792,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a widget",
"tags": [
"Widgets"
@@ -25155,11 +24868,6 @@
"description": "Site or Widget not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a clone of a widget",
"tags": [
"Widgets"
@@ -25242,11 +24950,6 @@
"description": "Site or Widget not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset widget text to default",
"tags": [
"Widgets"
@@ -25359,11 +25062,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgetsets in the specified site",
"tags": [
"WidgetSets"
@@ -25439,11 +25137,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new widgetset",
"tags": [
"WidgetSets"
@@ -25526,11 +25219,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing widgetset",
"tags": [
"WidgetSets"
@@ -25603,11 +25291,6 @@
"description": "Site or WidgetSet not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widgetset by its ID",
"tags": [
"WidgetSets"
@@ -25702,11 +25385,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing widgetset",
"tags": [
"WidgetSets"
@@ -25827,11 +25505,6 @@
"description": "Site or WidgetSet not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgets in the specified widgetset",
"tags": [
"Widgets",
@@ -25915,11 +25588,6 @@
"description": "Site or Widget not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widget by widgetset ID",
"tags": [
"Widgets",
@@ -26051,11 +25719,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of themes",
"tags": [
"Themes"
@@ -26130,11 +25793,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Uninstall a specified theme from the MT",
"tags": [
"Themes"
@@ -26197,11 +25855,6 @@
"description": "Site or Theme not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single theme by its ID",
"tags": [
"Themes"
@@ -26259,11 +25912,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Invalidate current session. This is like logout",
"tags": [
"Authentication"
@@ -26368,6 +26016,9 @@
{
"$ref": "#/components/parameters/user_offset"
},
+ {
+ "$ref": "#/components/parameters/user_filterKeys"
+ },
{
"description": "The field name for sort. You can specify one of following values\n- id\n- name\n\n**Default**: name\n",
"in": "query",
@@ -26552,11 +26203,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new user",
"tags": [
"Users"
@@ -26600,11 +26246,6 @@
"description": "Do not have permission to export users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export users",
"tags": [
"Users"
@@ -26677,11 +26318,6 @@
"description": "Do not have permission to import users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Import users",
"tags": [
"Users"
@@ -26730,11 +26366,6 @@
"description": "Do not have permission to synchronize users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Synchronize users",
"tags": [
"Users"
@@ -26809,11 +26440,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete user",
"tags": [
"Users"
@@ -26978,11 +26604,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update user data",
"tags": [
"Users"
@@ -27021,6 +26642,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/group_dateField"
},
@@ -27089,11 +26713,6 @@
"description": "User not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of groups",
"tags": [
"Users",
@@ -27131,6 +26750,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -27199,11 +26821,6 @@
"description": "Site or User not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for user",
"tags": [
"Users",
@@ -27293,11 +26910,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to user",
"tags": [
"Users",
@@ -27387,11 +26999,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from user",
"tags": [
"Users",
@@ -27465,11 +27072,6 @@
"description": "Site or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Send the link for password recovery to specified user by email",
"tags": [
"Users"
@@ -27698,11 +27300,6 @@
"description": "Site or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Unlock user account",
"tags": [
"Users"
@@ -27760,6 +27357,11 @@
}
}
},
+ "security": [
+ {
+ "mtauth": []
+ }
+ ],
"servers": [
{
"url": "https://example.com/mt/mt-data-api.cgi/v5"
diff --git a/src/openapi/v5.yaml b/src/openapi/v5.yaml
index 754418f..b08ecff 100644
--- a/src/openapi/v5.yaml
+++ b/src/openapi/v5.yaml
@@ -32,6 +32,16 @@ components:
name: fields
schema:
type: string
+ asset_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: class
+ in: query
+ name: filterKeys
+ schema:
+ default: class
+ type: string
asset_includeIds:
description: The comma separated ID list of assets to include to result.
in: query
@@ -133,6 +143,12 @@ components:
name: fields
schema:
type: string
+ category_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
category_includeIds:
description: The comma separated ID list of categories to include to result.
in: query
@@ -206,6 +222,12 @@ components:
name: fields
schema:
type: string
+ category_set_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
category_set_includeIds:
description: The comma separated ID list of category_sets to include to result.
in: query
@@ -335,6 +357,16 @@ components:
name: fields
schema:
type: string
+ comment_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
comment_includeIds:
description: The comma separated ID list of comments to include to result.
in: query
@@ -436,6 +468,16 @@ components:
name: fields
schema:
type: string
+ content_data_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
content_data_includeIds:
description: The comma separated ID list of content_data to include to result.
in: query
@@ -462,6 +504,15 @@ components:
schema:
default: 0
type: integer
+ content_data_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
content_data_search:
description: Search query.
in: query
@@ -537,6 +588,12 @@ components:
name: fields
schema:
type: string
+ content_field_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
content_field_includeIds:
description: The comma separated ID list of content_fields to include to result.
in: query
@@ -638,6 +695,12 @@ components:
name: fields
schema:
type: string
+ content_type_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
content_type_includeIds:
description: The comma separated ID list of content_types to include to result.
in: query
@@ -739,6 +802,16 @@ components:
name: fields
schema:
type: string
+ entry_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
entry_includeIds:
description: The comma separated ID list of entries to include to result.
in: query
@@ -786,6 +859,15 @@ components:
schema:
default: 0
type: integer
+ entry_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
entry_search:
description: Search query.
in: query
@@ -912,6 +994,16 @@ components:
name: fields
schema:
type: string
+ field_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: systemObject,type
+ in: query
+ name: filterKeys
+ schema:
+ default: 'systemObject,type'
+ type: string
field_includeIds:
description: The comma separated ID list of fields to include to result.
in: query
@@ -1013,6 +1105,12 @@ components:
name: fields
schema:
type: string
+ folder_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
folder_includeIds:
description: The comma separated ID list of folders to include to result.
in: query
@@ -1114,6 +1212,12 @@ components:
name: fields
schema:
type: string
+ formatted_text_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
formatted_text_includeIds:
description: The comma separated ID list of formatted_texts to include to result.
in: query
@@ -1215,6 +1319,16 @@ components:
name: fields
schema:
type: string
+ group_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
group_includeIds:
description: The comma separated ID list of groups to include to result.
in: query
@@ -1316,6 +1430,16 @@ components:
name: fields
schema:
type: string
+ log_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: level
+ in: query
+ name: filterKeys
+ schema:
+ default: level
+ type: string
log_includeIds:
description: The comma separated ID list of logs to include to result.
in: query
@@ -1417,6 +1541,16 @@ components:
name: fields
schema:
type: string
+ page_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
page_includeIds:
description: The comma separated ID list of pages to include to result.
in: query
@@ -1464,6 +1598,15 @@ components:
schema:
default: 0
type: integer
+ page_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
page_search:
description: Search query.
in: query
@@ -1596,6 +1739,16 @@ components:
name: fields
schema:
type: string
+ permission_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: blogIds
+ in: query
+ name: filterKeys
+ schema:
+ default: blogIds
+ type: string
permission_includeIds:
description: The comma separated ID list of permissions to include to result.
in: query
@@ -1709,6 +1862,12 @@ components:
name: fields
schema:
type: string
+ role_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
role_includeIds:
description: The comma separated ID list of roles to include to result.
in: query
@@ -1825,6 +1984,12 @@ components:
name: fields
schema:
type: string
+ site_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
site_includeIds:
description: The comma separated ID list of sites to include to result.
in: query
@@ -1932,6 +2097,12 @@ components:
name: fields
schema:
type: string
+ tag_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
tag_includeIds:
description: The comma separated ID list of tags to include to result.
in: query
@@ -2033,6 +2204,16 @@ components:
name: fields
schema:
type: string
+ template_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: type
+ in: query
+ name: filterKeys
+ schema:
+ default: type
+ type: string
template_includeIds:
description: The comma separated ID list of templates to include to result.
in: query
@@ -2059,6 +2240,15 @@ components:
schema:
default: 0
type: integer
+ template_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
template_search:
description: Search query.
in: query
@@ -2134,6 +2324,16 @@ components:
name: fields
schema:
type: string
+ templatemap_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: archiveType,buildType,isPreferred
+ in: query
+ name: filterKeys
+ schema:
+ default: 'archiveType,buildType,isPreferred'
+ type: string
templatemap_includeIds:
description: The comma separated ID list of templatemaps to include to result.
in: query
@@ -2231,6 +2431,16 @@ components:
name: fields
schema:
type: string
+ user_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status,lockout
+ in: query
+ name: filterKeys
+ schema:
+ default: 'status,lockout'
+ type: string
user_includeIds:
description: The comma separated ID list of users to include to result.
in: query
@@ -2332,6 +2542,12 @@ components:
name: fields
schema:
type: string
+ widget_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
widget_includeIds:
description: The comma separated ID list of widgets to include to result.
in: query
@@ -2433,6 +2649,12 @@ components:
name: fields
schema:
type: string
+ widgetset_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
widgetset_includeIds:
description: The comma separated ID list of widgetsets to include to result.
in: query
@@ -4888,7 +5110,7 @@ externalDocs:
url: https://www.movabletype.jp/developers/data-api/
info:
title: Movable Type Data API
- version: 8.6.0
+ version: 8.7.0
openapi: 3.0.0
paths:
/:
@@ -5020,8 +5242,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Upload file size is larger than CGIMaxUpload.
- security:
- - mtauth: []
summary: Upload a file
tags:
- Assets
@@ -5243,6 +5463,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/group_dateField'
- $ref: '#/components/parameters/group_dateFrom'
- $ref: '#/components/parameters/group_dateTo'
@@ -5276,8 +5497,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to retrieve the requested groups.
- security:
- - mtauth: []
summary: Retrieve a list of groups
tags:
- Groups
@@ -5311,8 +5530,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to create a group.
- security:
- - mtauth: []
summary: Create a new group
tags:
- Groups
@@ -5342,8 +5559,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to synchronize groups.
- security:
- - mtauth: []
summary: Synchronize groups
tags:
- Groups
@@ -5392,8 +5607,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a group
tags:
- Groups
@@ -5432,8 +5645,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve single group by its ID
tags:
- Groups
@@ -5489,8 +5700,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a group
tags:
- Groups
@@ -5509,6 +5718,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/user_dateField'
- $ref: '#/components/parameters/user_dateFrom'
- $ref: '#/components/parameters/user_dateTo'
@@ -5548,8 +5758,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve a list of members for specified group
tags:
- Groups
@@ -5598,8 +5806,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group or Member not found.
- security:
- - mtauth: []
tags:
- Groups
'/groups/{group_id}/members/{member_id}':
@@ -5652,8 +5858,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
tags:
- Groups
get:
@@ -5696,8 +5900,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group or Member not found.
- security:
- - mtauth: []
summary: Retrieve single member by its ID for specified group
tags:
- Groups
@@ -5718,6 +5920,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -5757,8 +5960,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for group
tags:
- Groups
@@ -5816,8 +6017,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Group not found
- security:
- - mtauth: []
summary: Grant permissions to group
tags:
- Groups
@@ -5875,8 +6074,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Group not found
- security:
- - mtauth: []
summary: Revoke permissions from group
tags:
- Groups
@@ -5893,6 +6090,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -5932,8 +6130,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions
tags:
- Permissions
@@ -5975,8 +6171,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of plugins in the specified site
tags:
- Plugins
@@ -6012,8 +6206,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Disable all plugins
tags:
- Plugins
@@ -6049,8 +6241,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Enable all plugins
tags:
- Plugins
@@ -6089,8 +6279,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found.
- security:
- - mtauth: []
summary: Retrieve single plugin by its ID
tags:
- Plugins
@@ -6132,8 +6320,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Disable a plugin
tags:
- Plugins
@@ -6175,8 +6361,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Enable a plugin
tags:
- Plugins
@@ -6239,8 +6423,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to publish content_data.
- security:
- - mtauth: []
summary: Publish Content Data
tags:
- Content Data
@@ -6318,8 +6500,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to publish.
- security:
- - mtauth: []
summary: Rebuild the static archives in relation to specified entries
tags:
- Entries
@@ -6421,8 +6601,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to retrieve the list of roles.
- security:
- - mtauth: []
summary: Retrieve a list of roles
tags:
- Roles
@@ -6462,8 +6640,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new role
tags:
- Roles
@@ -6512,8 +6688,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing role
tags:
- Roles
@@ -6552,8 +6726,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role not found.
- security:
- - mtauth: []
summary: Retrieve a single role by its ID
tags:
- Roles
@@ -6609,8 +6781,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing role
tags:
- Roles
@@ -6634,6 +6804,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -6673,8 +6844,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions by role
tags:
- Roles
@@ -6922,8 +7091,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new website
tags:
- Sites
@@ -6978,8 +7145,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing blog or website
tags:
- Sites
@@ -7078,8 +7243,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new blog
tags:
- Sites
@@ -7140,8 +7303,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing blog or website
tags:
- Sites
@@ -7162,6 +7323,7 @@ paths:
- $ref: '#/components/parameters/asset_searchFields'
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -7333,8 +7495,6 @@ paths:
type: object
type: object
description: Conflict
- security:
- - mtauth: []
summary: Upload a file
tags:
- Assets
@@ -7393,8 +7553,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an asset
tags:
- Assets
@@ -7508,8 +7666,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an asset
tags:
- Assets
@@ -7551,6 +7707,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -7632,6 +7789,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -7791,8 +7949,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Backup specified site
tags:
- Sites
@@ -7950,8 +8106,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new category
tags:
- Categories
@@ -8013,8 +8167,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Rearrange existing categories in a new order
tags:
- Categories
@@ -8074,8 +8226,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing category
tags:
- Categories
@@ -8189,8 +8339,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing category
tags:
- Categories
@@ -8313,6 +8461,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -8685,8 +8834,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new category set
tags:
- Category Sets
@@ -8743,8 +8890,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete category set
tags:
- Category Sets
@@ -8862,8 +9007,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update category set
tags:
- Category Sets
@@ -8902,6 +9045,11 @@ paths:
- 0
- 1
type: integer
+ - $ref: '#/components/parameters/category_limit'
+ - $ref: '#/components/parameters/category_offset'
+ - $ref: '#/components/parameters/category_searchFields'
+ - $ref: '#/components/parameters/category_sortBy'
+ - $ref: '#/components/parameters/category_sortOrder'
- $ref: '#/components/parameters/category_dateField'
- $ref: '#/components/parameters/category_dateFrom'
- $ref: '#/components/parameters/category_dateTo'
@@ -9000,8 +9148,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site pr Category_set not found.
- security:
- - mtauth: []
summary: Create a new category for category set
tags:
- Categories
@@ -9075,8 +9221,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Category_set not found.
- security:
- - mtauth: []
summary: Save hierarchical categories order in category set
tags:
- Categories
@@ -9141,8 +9285,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete single category in category set
tags:
- Categories
@@ -9273,8 +9415,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update single category in category set
tags:
- Categories
@@ -9673,6 +9813,10 @@ paths:
- Future
- Spam
type: string
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -9768,8 +9912,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a comment
tags:
- Comments
@@ -9884,8 +10026,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a comment
tags:
- Comments
@@ -9905,6 +10045,7 @@ paths:
type: integer
- $ref: '#/components/parameters/content_type_limit'
- $ref: '#/components/parameters/content_type_offset'
+ - $ref: '#/components/parameters/content_type_searchFields'
- description: |
The field name for sort. You can specify one of following values.
- name
@@ -9961,8 +10102,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Content Type Collection
tags:
- Content Types
@@ -10018,8 +10157,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create Content Type
tags:
- Content Types
@@ -10078,8 +10215,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete Content Type
tags:
- Content Types
@@ -10129,8 +10264,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Fetch single Content Type
tags:
- Content Types
@@ -10196,8 +10329,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update Content Type
tags:
- Content Types
@@ -10229,6 +10360,8 @@ paths:
type: string
- $ref: '#/components/parameters/content_data_limit'
- $ref: '#/components/parameters/content_data_offset'
+ - $ref: '#/components/parameters/content_data_filterKeys'
+ - $ref: '#/components/parameters/content_data_searchFields'
- description: |
The field name for sort. You can specify one of following values.
- id
@@ -10320,6 +10453,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/content_data_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -10355,8 +10489,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Create Content Data
tags:
- Content Types
@@ -10440,8 +10572,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found
- security:
- - mtauth: []
summary: Make a preview by data
tags:
- Content Types
@@ -10508,8 +10638,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete single content data
tags:
- Content Types
@@ -10606,6 +10734,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/content_data_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -10647,8 +10776,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update Content Data
tags:
- Content Types
@@ -10737,8 +10864,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type or Content_data not found
- security:
- - mtauth: []
summary: Make a preview by id
tags:
- Content Types
@@ -10764,6 +10889,7 @@ paths:
type: integer
- $ref: '#/components/parameters/content_field_limit'
- $ref: '#/components/parameters/content_field_offset'
+ - $ref: '#/components/parameters/content_field_searchFields'
- description: |
The field name for sort. You can specify one of following values.
- name
@@ -10820,8 +10946,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Content Field Collection
tags:
- Content Fields
@@ -10883,8 +11007,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Create Content Field
tags:
- Content Types
@@ -10957,8 +11079,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Save hierarchical content field order
tags:
- Content Types
@@ -11023,8 +11143,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete Content Field
tags:
- Content Types
@@ -11080,8 +11198,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type or Content_field not found.
- security:
- - mtauth: []
summary: Fetch single Content Field
tags:
- Content Types
@@ -11155,8 +11271,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update Content Field
tags:
- Content Types
@@ -11191,6 +11305,7 @@ paths:
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_fields'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -11250,6 +11365,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/entry_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -11291,8 +11407,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new entry
tags:
- Entries
@@ -11331,8 +11445,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Export entries
tags:
- Entries
@@ -11415,8 +11527,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Import entries
tags:
- Entries
@@ -11484,8 +11594,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Entry not found
- security:
- - mtauth: []
summary: Make a preview for a entry
tags:
- Entries
@@ -11543,8 +11651,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an entry
tags:
- Entries
@@ -11640,6 +11746,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/entry_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -11687,8 +11794,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an entry
tags:
- Entries
@@ -11742,6 +11847,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_sortOrder'
- $ref: '#/components/parameters/asset_fields'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- $ref: '#/components/parameters/asset_dateField'
- $ref: '#/components/parameters/asset_dateFrom'
- $ref: '#/components/parameters/asset_dateTo'
@@ -11947,6 +12054,10 @@ paths:
name: offset
schema:
type: integer
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -12041,8 +12152,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Create a new comment on an entry
tags:
- Comments
@@ -12104,8 +12213,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Reply to specified comment
tags:
- Comments
@@ -12180,8 +12287,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Entry not found
- security:
- - mtauth: []
summary: Make a preview for a entry with existing data
tags:
- Entries
@@ -12230,8 +12335,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found
- security:
- - mtauth: []
summary: Export site's theme
tags:
- Themes
@@ -12250,6 +12353,7 @@ paths:
- $ref: '#/components/parameters/field_sortBy'
- $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/field_fields'
+ - $ref: '#/components/parameters/field_filterKeys'
- $ref: '#/components/parameters/field_dateField'
- $ref: '#/components/parameters/field_dateFrom'
- $ref: '#/components/parameters/field_dateTo'
@@ -12289,8 +12393,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of fields in the specified site
tags:
- CustomFields
@@ -12336,8 +12438,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new field
tags:
- CustomFields
@@ -12391,8 +12491,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a field
tags:
- CustomFields
@@ -12436,8 +12534,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Field not found.
- security:
- - mtauth: []
summary: Retrieve single field by its ID
tags:
- CustomFields
@@ -12498,8 +12594,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a field
tags:
- CustomFields
@@ -12652,8 +12746,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new folder.
tags:
- Folders
@@ -12715,8 +12807,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Rearrange existing folders in a new order
tags:
- Folders
@@ -12776,8 +12866,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing folder
tags:
- Folders
@@ -12891,8 +12979,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing folder
tags:
- Folders
@@ -13010,6 +13096,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -13291,8 +13378,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of formatted_texts in the specified site
tags:
- FormattedText
@@ -13338,8 +13423,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new formatted_text
tags:
- FormattedText
@@ -13393,8 +13476,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a formatted_text
tags:
- FormattedText
@@ -13438,8 +13519,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or FormattedText not found.
- security:
- - mtauth: []
summary: Retrieve single formatted_text by its ID
tags:
- FormattedText
@@ -13500,8 +13579,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a formatted_text
tags:
- FormattedText
@@ -13553,8 +13630,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Reset logs
tags:
- Logs
@@ -13576,6 +13651,7 @@ paths:
- $ref: '#/components/parameters/log_searchFields'
- $ref: '#/components/parameters/log_limit'
- $ref: '#/components/parameters/log_offset'
+ - $ref: '#/components/parameters/log_filterKeys'
- description: |
- id
- created_on
@@ -13666,8 +13742,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of logs in the specified site
tags:
- Logs
@@ -13713,8 +13787,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new log
tags:
- Logs
@@ -13757,8 +13829,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Export logs
tags:
- Logs
@@ -13812,8 +13882,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing log
tags:
- Logs
@@ -13857,8 +13925,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Log not found.
- security:
- - mtauth: []
summary: Retrieve a single log by its ID
tags:
- Logs
@@ -13919,8 +13985,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing log
tags:
- Logs
@@ -13957,6 +14021,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -14016,6 +14081,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/page_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -14057,8 +14123,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new page
tags:
- Pages
@@ -14126,8 +14190,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Page not found
- security:
- - mtauth: []
summary: Make a preview for a page
tags:
- Pages
@@ -14186,8 +14248,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing page
tags:
- Pages
@@ -14265,6 +14325,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/page_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -14312,8 +14373,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing page
tags:
- Pages
@@ -14337,6 +14396,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -14440,6 +14501,10 @@ paths:
name: offset
schema:
type: integer
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -14534,8 +14599,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Create a new comment on a page
tags:
- Comments
@@ -14597,8 +14660,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Reply to specified comment
tags:
- Comments
@@ -14673,8 +14734,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Page not found
- security:
- - mtauth: []
summary: Make a preview for a page with existing data
tags:
- Pages
@@ -14738,8 +14797,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for site
tags:
- Sites
@@ -14797,8 +14854,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Grant permissions to site
tags:
- Sites
@@ -14856,8 +14911,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Revoke permissions from site
tags:
- Sites
@@ -14926,8 +14979,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Reset all templates in the site
tags:
- Templates
@@ -14943,14 +14994,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -14972,7 +15023,7 @@ paths:
name: path
schema:
type: string
- - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
+ - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
in: query
name: uniquePath
schema:
@@ -15020,8 +15071,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve pageviews count for each date from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -15037,14 +15086,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -15106,8 +15155,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve visits count for each date from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -15123,14 +15170,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -15152,7 +15199,7 @@ paths:
name: path
schema:
type: string
- - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
+ - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
in: query
name: uniquePath
schema:
@@ -15200,8 +15247,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve pageviews count for each path from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -15217,14 +15262,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -15286,8 +15331,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve visits count for each path from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -15331,8 +15374,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve a current effective provider
tags:
- Statistics
@@ -15443,8 +15484,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing tag
tags:
- Tags
@@ -15548,8 +15587,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing tag
tags:
- Tags
@@ -15573,6 +15610,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -15682,6 +15721,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -15763,6 +15803,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -15824,6 +15865,7 @@ paths:
- $ref: '#/components/parameters/template_searchFields'
- $ref: '#/components/parameters/template_limit'
- $ref: '#/components/parameters/template_offset'
+ - $ref: '#/components/parameters/template_filterKeys'
- description: |
#### id
@@ -15915,8 +15957,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of templates in the specified site
tags:
- Templates
@@ -15933,6 +15973,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/template_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -15968,8 +16009,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new template
tags:
- Templates
@@ -16038,8 +16077,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Make a preview for a template
tags:
- Templates
@@ -16098,8 +16135,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a template
tags:
- Templates
@@ -16149,8 +16184,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Retrieve single template by its ID
tags:
- Templates
@@ -16175,6 +16208,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/template_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -16216,8 +16250,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a template
tags:
- Templates
@@ -16270,8 +16302,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Make a clone of a template
tags:
- Templates
@@ -16351,8 +16381,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Make a preview for a template with existing data
tags:
- Templates
@@ -16411,8 +16439,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Publish a template
tags:
- Templates
@@ -16469,8 +16495,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Reset template text to theme default or tempalte_set default
tags:
- Templates
@@ -16496,6 +16520,7 @@ paths:
- $ref: '#/components/parameters/templatemap_fields'
- $ref: '#/components/parameters/templatemap_includeIds'
- $ref: '#/components/parameters/templatemap_excludeIds'
+ - $ref: '#/components/parameters/templatemap_filterKeys'
- $ref: '#/components/parameters/templatemap_dateField'
- $ref: '#/components/parameters/templatemap_dateFrom'
- $ref: '#/components/parameters/templatemap_dateTo'
@@ -16535,8 +16560,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Retrieve a list of templatemaps in the specified site
tags:
- Templates
@@ -16588,8 +16611,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Create a new templatemap
tags:
- Templates
@@ -16649,8 +16670,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing templatemap
tags:
- Templates
@@ -16699,8 +16718,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template or TemplateMap not found.
- security:
- - mtauth: []
summary: Retrieve a single templatemap by its ID
tags:
- Templates
@@ -16767,8 +16784,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing templatemap
tags:
- Templates
@@ -16823,8 +16838,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of themes for site
tags:
- Themes
@@ -16874,8 +16887,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found.
- security:
- - mtauth: []
summary: Retrieve a single theme by its ID for site
tags:
- Themes
@@ -16928,8 +16939,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found
- security:
- - mtauth: []
summary: Apply a theme to site
tags:
- Themes
@@ -16989,8 +16998,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgets in the specified site
tags:
- Widgets
@@ -17036,8 +17043,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new widget
tags:
- Widgets
@@ -17091,8 +17096,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a widget
tags:
- Widgets
@@ -17136,8 +17139,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found.
- security:
- - mtauth: []
summary: Retrieve a single widget by its ID
tags:
- Widgets
@@ -17198,8 +17199,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a widget
tags:
- Widgets
@@ -17246,8 +17245,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found
- security:
- - mtauth: []
summary: Make a clone of a widget
tags:
- Widgets
@@ -17298,8 +17295,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found
- security:
- - mtauth: []
summary: Reset widget text to default
tags:
- Widgets
@@ -17359,8 +17354,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgetsets in the specified site
tags:
- WidgetSets
@@ -17406,8 +17399,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new widgetset
tags:
- WidgetSets
@@ -17461,8 +17452,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing widgetset
tags:
- WidgetSets
@@ -17506,8 +17495,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or WidgetSet not found.
- security:
- - mtauth: []
summary: Retrieve a single widgetset by its ID
tags:
- WidgetSets
@@ -17568,8 +17555,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing widgetset
tags:
- WidgetSets
@@ -17634,8 +17619,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or WidgetSet not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgets in the specified widgetset
tags:
- Widgets
@@ -17686,8 +17669,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found.
- security:
- - mtauth: []
summary: Retrieve a single widget by widgetset ID
tags:
- Widgets
@@ -17776,8 +17757,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of themes
tags:
- Themes
@@ -17832,8 +17811,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Uninstall a specified theme from the MT
tags:
- Themes
@@ -17877,8 +17854,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found.
- security:
- - mtauth: []
summary: Retrieve a single theme by its ID
tags:
- Themes
@@ -17920,8 +17895,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Invalidate current session. This is like logout
tags:
- Authentication
@@ -17998,6 +17971,7 @@ paths:
- $ref: '#/components/parameters/user_searchFields'
- $ref: '#/components/parameters/user_limit'
- $ref: '#/components/parameters/user_offset'
+ - $ref: '#/components/parameters/user_filterKeys'
- description: |
The field name for sort. You can specify one of following values
- id
@@ -18139,8 +18113,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new user
tags:
- Users
@@ -18167,8 +18139,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to export users.
- security:
- - mtauth: []
summary: Export users
tags:
- Users
@@ -18213,8 +18183,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to import users.
- security:
- - mtauth: []
summary: Import users
tags:
- Users
@@ -18244,8 +18212,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to synchronize users.
- security:
- - mtauth: []
summary: Synchronize users
tags:
- Users
@@ -18300,8 +18266,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete user
tags:
- Users
@@ -18411,8 +18375,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update user data
tags:
- Users
@@ -18431,6 +18393,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/group_dateField'
- $ref: '#/components/parameters/group_dateFrom'
- $ref: '#/components/parameters/group_dateTo'
@@ -18470,8 +18433,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: User not found.
- security:
- - mtauth: []
summary: Retrieve a list of groups
tags:
- Users
@@ -18493,6 +18454,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -18532,8 +18494,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for user
tags:
- Users
@@ -18591,8 +18551,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Grant permissions to user
tags:
- Users
@@ -18650,8 +18608,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Revoke permissions from user
tags:
- Users
@@ -18702,8 +18658,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found
- security:
- - mtauth: []
summary: Send the link for password recovery to specified user by email
tags:
- Users
@@ -18867,8 +18821,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found
- security:
- - mtauth: []
summary: Unlock user account
tags:
- Users
@@ -18909,6 +18861,8 @@ paths:
summary: Get server API version
tags:
- Common API
+security:
+ - mtauth: []
servers:
- url: https://example.com/mt/mt-data-api.cgi/v5
tags:
diff --git a/src/openapi/v6.json b/src/openapi/v6.json
index 7e4bf1f..2445384 100644
--- a/src/openapi/v6.json
+++ b/src/openapi/v6.json
@@ -42,6 +42,15 @@
"type": "string"
}
},
+ "asset_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: class",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "class",
+ "type": "string"
+ }
+ },
"asset_includeIds": {
"description": "The comma separated ID list of assets to include to result.",
"in": "query",
@@ -148,6 +157,14 @@
"type": "string"
}
},
+ "category_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"category_includeIds": {
"description": "The comma separated ID list of categories to include to result.",
"in": "query",
@@ -232,6 +249,14 @@
"type": "string"
}
},
+ "category_set_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"category_set_includeIds": {
"description": "The comma separated ID list of category_sets to include to result.",
"in": "query",
@@ -360,6 +385,15 @@
"type": "string"
}
},
+ "comment_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"comment_includeIds": {
"description": "The comma separated ID list of comments to include to result.",
"in": "query",
@@ -466,6 +500,15 @@
"type": "string"
}
},
+ "content_data_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"content_data_includeIds": {
"description": "The comma separated ID list of content_data to include to result.",
"in": "query",
@@ -492,6 +535,18 @@
"type": "integer"
}
},
+ "content_data_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"content_data_search": {
"description": "Search query.",
"in": "query",
@@ -572,6 +627,14 @@
"type": "string"
}
},
+ "content_field_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"content_field_includeIds": {
"description": "The comma separated ID list of content_fields to include to result.",
"in": "query",
@@ -678,6 +741,14 @@
"type": "string"
}
},
+ "content_type_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"content_type_includeIds": {
"description": "The comma separated ID list of content_types to include to result.",
"in": "query",
@@ -784,6 +855,15 @@
"type": "string"
}
},
+ "entry_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"entry_includeIds": {
"description": "The comma separated ID list of entries to include to result.",
"in": "query",
@@ -838,6 +918,18 @@
"type": "integer"
}
},
+ "entry_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"entry_search": {
"description": "Search query.",
"in": "query",
@@ -940,6 +1032,15 @@
"type": "string"
}
},
+ "field_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: systemObject,type",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "systemObject,type",
+ "type": "string"
+ }
+ },
"field_includeIds": {
"description": "The comma separated ID list of fields to include to result.",
"in": "query",
@@ -1046,6 +1147,14 @@
"type": "string"
}
},
+ "folder_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"folder_includeIds": {
"description": "The comma separated ID list of folders to include to result.",
"in": "query",
@@ -1152,6 +1261,14 @@
"type": "string"
}
},
+ "formatted_text_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"formatted_text_includeIds": {
"description": "The comma separated ID list of formatted_texts to include to result.",
"in": "query",
@@ -1258,6 +1375,15 @@
"type": "string"
}
},
+ "group_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"group_includeIds": {
"description": "The comma separated ID list of groups to include to result.",
"in": "query",
@@ -1364,6 +1490,15 @@
"type": "string"
}
},
+ "log_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: level",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "level",
+ "type": "string"
+ }
+ },
"log_includeIds": {
"description": "The comma separated ID list of logs to include to result.",
"in": "query",
@@ -1470,6 +1605,15 @@
"type": "string"
}
},
+ "page_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"page_includeIds": {
"description": "The comma separated ID list of pages to include to result.",
"in": "query",
@@ -1524,6 +1668,18 @@
"type": "integer"
}
},
+ "page_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"page_search": {
"description": "Search query.",
"in": "query",
@@ -1634,6 +1790,15 @@
"type": "string"
}
},
+ "permission_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: blogIds",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "blogIds",
+ "type": "string"
+ }
+ },
"permission_includeIds": {
"description": "The comma separated ID list of permissions to include to result.",
"in": "query",
@@ -1746,6 +1911,14 @@
"type": "string"
}
},
+ "role_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"role_includeIds": {
"description": "The comma separated ID list of roles to include to result.",
"in": "query",
@@ -1859,6 +2032,14 @@
"type": "string"
}
},
+ "site_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"site_includeIds": {
"description": "The comma separated ID list of sites to include to result.",
"in": "query",
@@ -1968,6 +2149,14 @@
"type": "string"
}
},
+ "tag_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"tag_includeIds": {
"description": "The comma separated ID list of tags to include to result.",
"in": "query",
@@ -2074,6 +2263,15 @@
"type": "string"
}
},
+ "template_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: type",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "type",
+ "type": "string"
+ }
+ },
"template_includeIds": {
"description": "The comma separated ID list of templates to include to result.",
"in": "query",
@@ -2100,6 +2298,18 @@
"type": "integer"
}
},
+ "template_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"template_search": {
"description": "Search query.",
"in": "query",
@@ -2180,6 +2390,15 @@
"type": "string"
}
},
+ "templatemap_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: archiveType,buildType,isPreferred",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "archiveType,buildType,isPreferred",
+ "type": "string"
+ }
+ },
"templatemap_includeIds": {
"description": "The comma separated ID list of templatemaps to include to result.",
"in": "query",
@@ -2285,6 +2504,15 @@
"type": "string"
}
},
+ "user_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status,lockout",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status,lockout",
+ "type": "string"
+ }
+ },
"user_includeIds": {
"description": "The comma separated ID list of users to include to result.",
"in": "query",
@@ -2391,6 +2619,14 @@
"type": "string"
}
},
+ "widget_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"widget_includeIds": {
"description": "The comma separated ID list of widgets to include to result.",
"in": "query",
@@ -2497,6 +2733,14 @@
"type": "string"
}
},
+ "widgetset_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"widgetset_includeIds": {
"description": "The comma separated ID list of widgetsets to include to result.",
"in": "query",
@@ -5137,11 +5381,11 @@
"type": "string"
},
"screenPageViews": {
- "description": "The pageviews for the path. This property exists only if the metrics to retrieve is \"pageviews\"",
+ "description": "The number of screenPageViews for the path. This property exists only if the metrics to retrieve is \"screenPageViews\"",
"type": "integer"
},
"sessions": {
- "description": "The number of sessions for the path. This property exists only if the metrics to retrieve is \"visits\"",
+ "description": "The number of sessions for the path. This property exists only if the metrics to retrieve is \"sessions\"",
"type": "integer"
}
},
@@ -5192,11 +5436,11 @@
"type": "string"
},
"screenPageViews": {
- "description": "The pageviews for the path. This property exists only if the metrics to retrieve is \"pageviews\"",
+ "description": "The number of screenPageViews for the path. This property exists only if the metrics to retrieve is \"screenPageViews\"",
"type": "integer"
},
"sessions": {
- "description": "The number of sessions for the path. This property exists only if the metrics to retrieve is \"visits\"",
+ "description": "The number of sessions for the path. This property exists only if the metrics to retrieve is \"sessions\"",
"type": "integer"
}
},
@@ -6182,7 +6426,7 @@
},
"info": {
"title": "Movable Type Data API",
- "version": "8.6.0"
+ "version": "8.7.0"
},
"openapi": "3.0.0",
"paths": {
@@ -6386,11 +6630,6 @@
"description": "Upload file size is larger than CGIMaxUpload."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Upload a file",
"tags": [
"Assets"
@@ -6730,6 +6969,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/group_dateField"
},
@@ -6788,11 +7030,6 @@
"description": "Do not have permission to retrieve the requested groups."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of groups",
"tags": [
"Groups"
@@ -6848,11 +7085,6 @@
"description": "Do not have permission to create a group."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new group",
"tags": [
"Groups"
@@ -6901,11 +7133,6 @@
"description": "Do not have permission to synchronize groups."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Synchronize groups",
"tags": [
"Groups"
@@ -6980,11 +7207,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a group",
"tags": [
"Groups"
@@ -7049,11 +7271,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single group by its ID",
"tags": [
"Groups"
@@ -7140,11 +7357,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a group",
"tags": [
"Groups"
@@ -7183,6 +7395,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/user_dateField"
},
@@ -7251,11 +7466,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of members for specified group",
"tags": [
"Groups"
@@ -7336,11 +7546,6 @@
"description": "Group or Member not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"tags": [
"Groups"
]
@@ -7422,11 +7627,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"tags": [
"Groups"
]
@@ -7498,11 +7698,6 @@
"description": "Group or Member not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single member by its ID for specified group",
"tags": [
"Groups"
@@ -7539,6 +7734,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -7607,11 +7805,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for group",
"tags": [
"Groups",
@@ -7701,11 +7894,6 @@
"description": "Site or Group not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to group",
"tags": [
"Groups",
@@ -7795,11 +7983,6 @@
"description": "Site or Group not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from group",
"tags": [
"Groups",
@@ -7829,6 +8012,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -7897,11 +8083,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions",
"tags": [
"Permissions"
@@ -7968,11 +8149,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of plugins in the specified site",
"tags": [
"Plugins"
@@ -8031,11 +8207,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Disable all plugins",
"tags": [
"Plugins"
@@ -8094,11 +8265,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Enable all plugins",
"tags": [
"Plugins"
@@ -8162,11 +8328,6 @@
"description": "Site or Plugin not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single plugin by its ID",
"tags": [
"Plugins"
@@ -8235,11 +8396,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Disable a plugin",
"tags": [
"Plugins"
@@ -8308,11 +8464,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Enable a plugin",
"tags": [
"Plugins"
@@ -8405,11 +8556,6 @@
"description": "Do not have permission to publish content_data."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Publish Content Data",
"tags": [
"Content Data",
@@ -8508,11 +8654,6 @@
"description": "Do not have permission to publish."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rebuild the static archives in relation to specified entries",
"tags": [
"Entries",
@@ -8680,11 +8821,6 @@
"description": "Do not have permission to retrieve the list of roles."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of roles",
"tags": [
"Roles"
@@ -8750,11 +8886,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new role",
"tags": [
"Roles"
@@ -8829,11 +8960,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing role",
"tags": [
"Roles"
@@ -8898,11 +9024,6 @@
"description": "Site or Role not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single role by its ID",
"tags": [
"Roles"
@@ -8989,11 +9110,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing role",
"tags": [
"Roles"
@@ -9030,6 +9146,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -9098,11 +9217,6 @@
"description": "Site or Role not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions by role",
"tags": [
"Roles",
@@ -9436,11 +9550,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new website",
"tags": [
"Sites"
@@ -9515,11 +9624,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing blog or website",
"tags": [
"Sites"
@@ -9673,11 +9777,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new blog",
"tags": [
"Sites"
@@ -9764,11 +9863,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing blog or website",
"tags": [
"Sites"
@@ -9806,6 +9900,9 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -10051,11 +10148,6 @@
"description": "Conflict"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Upload a file",
"tags": [
"Assets"
@@ -10138,11 +10230,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an asset",
"tags": [
"Assets"
@@ -10317,11 +10404,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an asset",
"tags": [
"Assets"
@@ -10395,6 +10477,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -10537,6 +10622,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -10799,11 +10887,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Backup specified site",
"tags": [
"Sites",
@@ -11025,11 +11108,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new category",
"tags": [
"Categories"
@@ -11113,11 +11191,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rearrange existing categories in a new order",
"tags": [
"Categories"
@@ -11200,11 +11273,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing category",
"tags": [
"Categories"
@@ -11379,11 +11447,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing category",
"tags": [
"Categories"
@@ -11568,6 +11631,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -12108,11 +12174,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new category set",
"tags": [
"Category Sets"
@@ -12195,11 +12256,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete category set",
"tags": [
"Category Sets"
@@ -12375,11 +12431,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update category set",
"tags": [
"Category Sets"
@@ -12435,6 +12486,21 @@
"type": "integer"
}
},
+ {
+ "$ref": "#/components/parameters/category_limit"
+ },
+ {
+ "$ref": "#/components/parameters/category_offset"
+ },
+ {
+ "$ref": "#/components/parameters/category_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/category_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/category_sortOrder"
+ },
{
"$ref": "#/components/parameters/category_dateField"
},
@@ -12586,11 +12652,6 @@
"description": "Site pr Category_set not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new category for category set",
"tags": [
"Categories",
@@ -12683,11 +12744,6 @@
"description": "Site or Category_set not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Save hierarchical categories order in category set",
"tags": [
"Categories",
@@ -12779,11 +12835,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete single category in category set",
"tags": [
"Categories",
@@ -12977,11 +13028,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update single category in category set",
"tags": [
"Categories",
@@ -13593,6 +13639,18 @@
"type": "string"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -13743,11 +13801,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a comment",
"tags": [
"Comments"
@@ -13920,11 +13973,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a comment",
"tags": [
"Comments"
@@ -13949,6 +13997,9 @@
{
"$ref": "#/components/parameters/content_type_offset"
},
+ {
+ "$ref": "#/components/parameters/content_type_searchFields"
+ },
{
"description": "The field name for sort. You can specify one of following values.\n- name\n- dataLabel\n- uniqueID\n- modified_on\n",
"in": "query",
@@ -14041,11 +14092,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Content Type Collection",
"tags": [
"Content Types"
@@ -14122,11 +14168,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create Content Type",
"tags": [
"Content Types"
@@ -14209,11 +14250,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete Content Type",
"tags": [
"Content Types"
@@ -14287,11 +14323,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Fetch single Content Type",
"tags": [
"Content Types"
@@ -14386,11 +14417,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update Content Type",
"tags": [
"Content Types"
@@ -14431,6 +14457,12 @@
{
"$ref": "#/components/parameters/content_data_offset"
},
+ {
+ "$ref": "#/components/parameters/content_data_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/content_data_searchFields"
+ },
{
"description": "The field name for sort. You can specify one of following values.\n- id\n- uniqueID\n- authored_on\n- created_on\n- modified_on\n",
"in": "query",
@@ -14552,6 +14584,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/content_data_saveRevision"
}
],
"requestBody": {
@@ -14613,11 +14648,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create Content Data",
"tags": [
"Content Types",
@@ -14726,11 +14756,6 @@
"description": "Site or Content_type not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview by data",
"tags": [
"Content Types",
@@ -14822,11 +14847,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete single content data",
"tags": [
"Content Types",
@@ -14949,6 +14969,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/content_data_saveRevision"
}
],
"requestBody": {
@@ -15020,11 +15043,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update Content Data",
"tags": [
"Content Types",
@@ -15141,11 +15159,6 @@
"description": "Site or Content_type or Content_data not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview by id",
"tags": [
"Content Types",
@@ -15179,6 +15192,9 @@
{
"$ref": "#/components/parameters/content_field_offset"
},
+ {
+ "$ref": "#/components/parameters/content_field_searchFields"
+ },
{
"description": "The field name for sort. You can specify one of following values.\n- name\n- dataLabel\n- uniqueID\n- modified_on\n",
"in": "query",
@@ -15271,11 +15287,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Content Field Collection",
"tags": [
"Content Fields",
@@ -15361,11 +15372,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create Content Field",
"tags": [
"Content Types",
@@ -15458,11 +15464,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Save hierarchical content field order",
"tags": [
"Content Types",
@@ -15554,11 +15555,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete Content Field",
"tags": [
"Content Types",
@@ -15641,11 +15637,6 @@
"description": "Site or Content_type or Content_field not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Fetch single Content Field",
"tags": [
"Content Types",
@@ -15749,11 +15740,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update Content Field",
"tags": [
"Content Types",
@@ -15820,6 +15806,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -15903,6 +15892,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_saveRevision"
}
],
"requestBody": {
@@ -15972,11 +15964,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new entry",
"tags": [
"Entries"
@@ -16040,11 +16027,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export entries",
"tags": [
"Entries"
@@ -16160,11 +16142,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Import entries",
"tags": [
"Entries"
@@ -16264,11 +16241,6 @@
"description": "Site or Entry not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a entry",
"tags": [
"Entries"
@@ -16351,11 +16323,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an entry",
"tags": [
"Entries"
@@ -16481,6 +16448,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_saveRevision"
}
],
"requestBody": {
@@ -16560,11 +16530,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an entry",
"tags": [
"Entries"
@@ -16632,6 +16597,12 @@
{
"$ref": "#/components/parameters/asset_fields"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"$ref": "#/components/parameters/asset_dateField"
},
@@ -16914,6 +16885,18 @@
"type": "integer"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -17067,11 +17050,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new comment on an entry",
"tags": [
"Comments",
@@ -17167,11 +17145,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reply to specified comment",
"tags": [
"Comments",
@@ -17280,11 +17253,6 @@
"description": "Site or Entry not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a entry with existing data",
"tags": [
"Entries"
@@ -17354,11 +17322,6 @@
"description": "Site or Theme not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export site's theme",
"tags": [
"Themes"
@@ -17397,6 +17360,9 @@
{
"$ref": "#/components/parameters/field_fields"
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
{
"$ref": "#/components/parameters/field_dateField"
},
@@ -17465,11 +17431,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of fields in the specified site",
"tags": [
"CustomFields"
@@ -17545,11 +17506,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new field",
"tags": [
"CustomFields"
@@ -17632,11 +17588,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a field",
"tags": [
"CustomFields"
@@ -17709,11 +17660,6 @@
"description": "Site or Field not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single field by its ID",
"tags": [
"CustomFields"
@@ -17808,11 +17754,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a field",
"tags": [
"CustomFields"
@@ -18024,11 +17965,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new folder.",
"tags": [
"Folders"
@@ -18112,11 +18048,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rearrange existing folders in a new order",
"tags": [
"Folders"
@@ -18199,11 +18130,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing folder",
"tags": [
"Folders"
@@ -18378,11 +18304,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing folder",
"tags": [
"Folders"
@@ -18558,6 +18479,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -18984,11 +18908,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of formatted_texts in the specified site",
"tags": [
"FormattedText"
@@ -19064,11 +18983,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new formatted_text",
"tags": [
"FormattedText"
@@ -19151,11 +19065,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a formatted_text",
"tags": [
"FormattedText"
@@ -19228,11 +19137,6 @@
"description": "Site or FormattedText not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single formatted_text by its ID",
"tags": [
"FormattedText"
@@ -19327,11 +19231,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a formatted_text",
"tags": [
"FormattedText"
@@ -19411,11 +19310,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset logs",
"tags": [
"Logs"
@@ -19444,6 +19338,9 @@
{
"$ref": "#/components/parameters/log_offset"
},
+ {
+ "$ref": "#/components/parameters/log_filterKeys"
+ },
{
"description": "- id\n- created_on\n- blog_id\n- author_id\n- level\n- class\n\n**Default**: created_on\n",
"in": "query",
@@ -19560,11 +19457,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of logs in the specified site",
"tags": [
"Logs"
@@ -19640,11 +19532,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new log",
"tags": [
"Logs"
@@ -19715,11 +19602,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export logs",
"tags": [
"Logs"
@@ -19802,11 +19684,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing log",
"tags": [
"Logs"
@@ -19879,11 +19756,6 @@
"description": "Site or Log not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single log by its ID",
"tags": [
"Logs"
@@ -19978,11 +19850,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing log",
"tags": [
"Logs"
@@ -20048,6 +19915,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -20131,6 +20001,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/page_saveRevision"
}
],
"requestBody": {
@@ -20200,11 +20073,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new page",
"tags": [
"Pages"
@@ -20304,11 +20172,6 @@
"description": "Site or Page not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a page",
"tags": [
"Pages"
@@ -20391,11 +20254,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing page",
"tags": [
"Pages"
@@ -20500,6 +20358,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/page_saveRevision"
}
],
"requestBody": {
@@ -20579,11 +20440,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing page",
"tags": [
"Pages"
@@ -20623,6 +20479,12 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -20768,6 +20630,18 @@
"type": "integer"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -20921,11 +20795,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new comment on a page",
"tags": [
"Comments",
@@ -21021,11 +20890,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reply to specified comment",
"tags": [
"Comments",
@@ -21134,11 +20998,6 @@
"description": "Site or Page not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a page with existing data",
"tags": [
"Pages"
@@ -21240,11 +21099,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for site",
"tags": [
"Sites",
@@ -21334,11 +21188,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to site",
"tags": [
"Sites",
@@ -21428,11 +21277,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from site",
"tags": [
"Sites",
@@ -21516,11 +21360,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset all templates in the site",
"tags": [
"Templates"
@@ -21540,7 +21379,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -21550,7 +21389,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -21585,7 +21424,7 @@
}
},
{
- "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
"in": "query",
"name": "uniquePath",
"schema": {
@@ -21617,7 +21456,7 @@
"totals": {
"properties": {
"screenPageViews": {
- "description": "The sum total of the pageviews in the specified period.",
+ "description": "The sum total of the screenPageViews in the specified period.",
"type": "integer"
}
},
@@ -21661,11 +21500,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve pageviews count for each date from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -21685,7 +21519,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -21695,7 +21529,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -21794,11 +21628,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve visits count for each date from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -21818,7 +21647,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -21828,7 +21657,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -21863,7 +21692,7 @@
}
},
{
- "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
"in": "query",
"name": "uniquePath",
"schema": {
@@ -21895,7 +21724,7 @@
"totals": {
"properties": {
"screenPageViews": {
- "description": "The sum total of the pageviews in the specified period.",
+ "description": "The sum total of the screenPageViews in the specified period.",
"type": "integer"
}
},
@@ -21939,11 +21768,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve pageviews count for each path from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -21963,7 +21787,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -21973,7 +21797,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -22072,11 +21896,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve visits count for each path from provider (e.g. Google Analytics)",
"tags": [
"Statistics"
@@ -22143,11 +21962,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a current effective provider",
"tags": [
"Statistics"
@@ -22336,11 +22150,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing tag",
"tags": [
"Tags"
@@ -22507,11 +22316,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing tag",
"tags": [
"Tags"
@@ -22551,6 +22355,12 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -22719,6 +22529,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -22861,6 +22674,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -22960,6 +22776,9 @@
{
"$ref": "#/components/parameters/template_offset"
},
+ {
+ "$ref": "#/components/parameters/template_filterKeys"
+ },
{
"description": "#### id\n\nSort by the ID of each template.\n\n#### name\n\nSort by the name of each template.\n\n#### created_on\n\nSort by the created time of each template.\n\n#### modified_on\n\nSort by the modified time of each template.\n\n#### created_by\n\nSort by the ID of user who created each template.\n\n#### modified_by\n\nSort by the ID of user who modified each template.\n\n#### type\n\nSort by the type of each template.\n\n**Default**: name\n",
"in": "query",
@@ -23066,11 +22885,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of templates in the specified site",
"tags": [
"Templates"
@@ -23086,6 +22900,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/template_saveRevision"
}
],
"requestBody": {
@@ -23147,11 +22964,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new template",
"tags": [
"Templates"
@@ -23251,11 +23063,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a template",
"tags": [
"Templates"
@@ -23338,11 +23145,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a template",
"tags": [
"Templates"
@@ -23416,11 +23218,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single template by its ID",
"tags": [
"Templates"
@@ -23444,6 +23241,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/template_saveRevision"
}
],
"requestBody": {
@@ -23515,11 +23315,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a template",
"tags": [
"Templates"
@@ -23597,11 +23392,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a clone of a template",
"tags": [
"Templates"
@@ -23709,11 +23499,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a template with existing data",
"tags": [
"Templates"
@@ -23791,11 +23576,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Publish a template",
"tags": [
"Templates"
@@ -23879,11 +23659,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset template text to theme default or tempalte_set default",
"tags": [
"Templates"
@@ -23936,6 +23711,9 @@
{
"$ref": "#/components/parameters/templatemap_excludeIds"
},
+ {
+ "$ref": "#/components/parameters/templatemap_filterKeys"
+ },
{
"$ref": "#/components/parameters/templatemap_dateField"
},
@@ -24004,11 +23782,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of templatemaps in the specified site",
"tags": [
"Templates",
@@ -24093,11 +23866,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new templatemap",
"tags": [
"Templates",
@@ -24189,11 +23957,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing templatemap",
"tags": [
"Templates",
@@ -24272,11 +24035,6 @@
"description": "Site or Template or TemplateMap not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single templatemap by its ID",
"tags": [
"Templates",
@@ -24380,11 +24138,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing templatemap",
"tags": [
"Templates",
@@ -24463,11 +24216,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of themes for site",
"tags": [
"Themes"
@@ -24540,11 +24288,6 @@
"description": "Site or Theme not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single theme by its ID for site",
"tags": [
"Themes"
@@ -24622,11 +24365,6 @@
"description": "Site or Theme not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Apply a theme to site",
"tags": [
"Themes"
@@ -24739,11 +24477,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgets in the specified site",
"tags": [
"Widgets"
@@ -24819,11 +24552,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new widget",
"tags": [
"Widgets"
@@ -24906,11 +24634,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a widget",
"tags": [
"Widgets"
@@ -24983,11 +24706,6 @@
"description": "Site or Widget not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widget by its ID",
"tags": [
"Widgets"
@@ -25082,11 +24800,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a widget",
"tags": [
"Widgets"
@@ -25163,11 +24876,6 @@
"description": "Site or Widget not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a clone of a widget",
"tags": [
"Widgets"
@@ -25250,11 +24958,6 @@
"description": "Site or Widget not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset widget text to default",
"tags": [
"Widgets"
@@ -25367,11 +25070,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgetsets in the specified site",
"tags": [
"WidgetSets"
@@ -25447,11 +25145,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new widgetset",
"tags": [
"WidgetSets"
@@ -25534,11 +25227,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing widgetset",
"tags": [
"WidgetSets"
@@ -25611,11 +25299,6 @@
"description": "Site or WidgetSet not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widgetset by its ID",
"tags": [
"WidgetSets"
@@ -25710,11 +25393,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing widgetset",
"tags": [
"WidgetSets"
@@ -25835,11 +25513,6 @@
"description": "Site or WidgetSet not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgets in the specified widgetset",
"tags": [
"Widgets",
@@ -25923,11 +25596,6 @@
"description": "Site or Widget not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widget by widgetset ID",
"tags": [
"Widgets",
@@ -26059,11 +25727,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of themes",
"tags": [
"Themes"
@@ -26138,11 +25801,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Uninstall a specified theme from the MT",
"tags": [
"Themes"
@@ -26205,11 +25863,6 @@
"description": "Site or Theme not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single theme by its ID",
"tags": [
"Themes"
@@ -26267,11 +25920,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Invalidate current session. This is like logout",
"tags": [
"Authentication"
@@ -26376,6 +26024,9 @@
{
"$ref": "#/components/parameters/user_offset"
},
+ {
+ "$ref": "#/components/parameters/user_filterKeys"
+ },
{
"description": "The field name for sort. You can specify one of following values\n- id\n- name\n\n**Default**: name\n",
"in": "query",
@@ -26560,11 +26211,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new user",
"tags": [
"Users"
@@ -26608,11 +26254,6 @@
"description": "Do not have permission to export users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export users",
"tags": [
"Users"
@@ -26685,11 +26326,6 @@
"description": "Do not have permission to import users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Import users",
"tags": [
"Users"
@@ -26738,11 +26374,6 @@
"description": "Do not have permission to synchronize users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Synchronize users",
"tags": [
"Users"
@@ -26817,11 +26448,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete user",
"tags": [
"Users"
@@ -26986,11 +26612,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update user data",
"tags": [
"Users"
@@ -27029,6 +26650,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/group_dateField"
},
@@ -27097,11 +26721,6 @@
"description": "User not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of groups",
"tags": [
"Users",
@@ -27139,6 +26758,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -27207,11 +26829,6 @@
"description": "Site or User not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for user",
"tags": [
"Users",
@@ -27301,11 +26918,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to user",
"tags": [
"Users",
@@ -27395,11 +27007,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from user",
"tags": [
"Users",
@@ -27473,11 +27080,6 @@
"description": "Site or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Send the link for password recovery to specified user by email",
"tags": [
"Users"
@@ -27706,11 +27308,6 @@
"description": "Site or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Unlock user account",
"tags": [
"Users"
@@ -27768,6 +27365,11 @@
}
}
},
+ "security": [
+ {
+ "mtauth": []
+ }
+ ],
"servers": [
{
"url": "https://example.com/mt/mt-data-api.cgi/v6"
diff --git a/src/openapi/v6.yaml b/src/openapi/v6.yaml
index 453d137..96cfa5a 100644
--- a/src/openapi/v6.yaml
+++ b/src/openapi/v6.yaml
@@ -32,6 +32,16 @@ components:
name: fields
schema:
type: string
+ asset_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: class
+ in: query
+ name: filterKeys
+ schema:
+ default: class
+ type: string
asset_includeIds:
description: The comma separated ID list of assets to include to result.
in: query
@@ -133,6 +143,12 @@ components:
name: fields
schema:
type: string
+ category_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
category_includeIds:
description: The comma separated ID list of categories to include to result.
in: query
@@ -206,6 +222,12 @@ components:
name: fields
schema:
type: string
+ category_set_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
category_set_includeIds:
description: The comma separated ID list of category_sets to include to result.
in: query
@@ -335,6 +357,16 @@ components:
name: fields
schema:
type: string
+ comment_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
comment_includeIds:
description: The comma separated ID list of comments to include to result.
in: query
@@ -436,6 +468,16 @@ components:
name: fields
schema:
type: string
+ content_data_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
content_data_includeIds:
description: The comma separated ID list of content_data to include to result.
in: query
@@ -462,6 +504,15 @@ components:
schema:
default: 0
type: integer
+ content_data_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
content_data_search:
description: Search query.
in: query
@@ -537,6 +588,12 @@ components:
name: fields
schema:
type: string
+ content_field_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
content_field_includeIds:
description: The comma separated ID list of content_fields to include to result.
in: query
@@ -638,6 +695,12 @@ components:
name: fields
schema:
type: string
+ content_type_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
content_type_includeIds:
description: The comma separated ID list of content_types to include to result.
in: query
@@ -739,6 +802,16 @@ components:
name: fields
schema:
type: string
+ entry_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
entry_includeIds:
description: The comma separated ID list of entries to include to result.
in: query
@@ -786,6 +859,15 @@ components:
schema:
default: 0
type: integer
+ entry_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
entry_search:
description: Search query.
in: query
@@ -912,6 +994,16 @@ components:
name: fields
schema:
type: string
+ field_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: systemObject,type
+ in: query
+ name: filterKeys
+ schema:
+ default: 'systemObject,type'
+ type: string
field_includeIds:
description: The comma separated ID list of fields to include to result.
in: query
@@ -1013,6 +1105,12 @@ components:
name: fields
schema:
type: string
+ folder_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
folder_includeIds:
description: The comma separated ID list of folders to include to result.
in: query
@@ -1114,6 +1212,12 @@ components:
name: fields
schema:
type: string
+ formatted_text_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
formatted_text_includeIds:
description: The comma separated ID list of formatted_texts to include to result.
in: query
@@ -1215,6 +1319,16 @@ components:
name: fields
schema:
type: string
+ group_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
group_includeIds:
description: The comma separated ID list of groups to include to result.
in: query
@@ -1316,6 +1430,16 @@ components:
name: fields
schema:
type: string
+ log_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: level
+ in: query
+ name: filterKeys
+ schema:
+ default: level
+ type: string
log_includeIds:
description: The comma separated ID list of logs to include to result.
in: query
@@ -1417,6 +1541,16 @@ components:
name: fields
schema:
type: string
+ page_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
page_includeIds:
description: The comma separated ID list of pages to include to result.
in: query
@@ -1464,6 +1598,15 @@ components:
schema:
default: 0
type: integer
+ page_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
page_search:
description: Search query.
in: query
@@ -1596,6 +1739,16 @@ components:
name: fields
schema:
type: string
+ permission_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: blogIds
+ in: query
+ name: filterKeys
+ schema:
+ default: blogIds
+ type: string
permission_includeIds:
description: The comma separated ID list of permissions to include to result.
in: query
@@ -1709,6 +1862,12 @@ components:
name: fields
schema:
type: string
+ role_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
role_includeIds:
description: The comma separated ID list of roles to include to result.
in: query
@@ -1825,6 +1984,12 @@ components:
name: fields
schema:
type: string
+ site_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
site_includeIds:
description: The comma separated ID list of sites to include to result.
in: query
@@ -1932,6 +2097,12 @@ components:
name: fields
schema:
type: string
+ tag_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
tag_includeIds:
description: The comma separated ID list of tags to include to result.
in: query
@@ -2033,6 +2204,16 @@ components:
name: fields
schema:
type: string
+ template_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: type
+ in: query
+ name: filterKeys
+ schema:
+ default: type
+ type: string
template_includeIds:
description: The comma separated ID list of templates to include to result.
in: query
@@ -2059,6 +2240,15 @@ components:
schema:
default: 0
type: integer
+ template_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
template_search:
description: Search query.
in: query
@@ -2134,6 +2324,16 @@ components:
name: fields
schema:
type: string
+ templatemap_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: archiveType,buildType,isPreferred
+ in: query
+ name: filterKeys
+ schema:
+ default: 'archiveType,buildType,isPreferred'
+ type: string
templatemap_includeIds:
description: The comma separated ID list of templatemaps to include to result.
in: query
@@ -2231,6 +2431,16 @@ components:
name: fields
schema:
type: string
+ user_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status,lockout
+ in: query
+ name: filterKeys
+ schema:
+ default: 'status,lockout'
+ type: string
user_includeIds:
description: The comma separated ID list of users to include to result.
in: query
@@ -2332,6 +2542,12 @@ components:
name: fields
schema:
type: string
+ widget_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
widget_includeIds:
description: The comma separated ID list of widgets to include to result.
in: query
@@ -2433,6 +2649,12 @@ components:
name: fields
schema:
type: string
+ widgetset_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
widgetset_includeIds:
description: The comma separated ID list of widgetsets to include to result.
in: query
@@ -4199,10 +4421,10 @@ components:
format: date
type: string
screenPageViews:
- description: The pageviews for the path. This property exists only if the metrics to retrieve is "pageviews"
+ description: The number of screenPageViews for the path. This property exists only if the metrics to retrieve is "screenPageViews"
type: integer
sessions:
- description: The number of sessions for the path. This property exists only if the metrics to retrieve is "visits"
+ description: The number of sessions for the path. This property exists only if the metrics to retrieve is "sessions"
type: integer
type: object
statisticspath:
@@ -4238,10 +4460,10 @@ components:
description: The title for the path.
type: string
screenPageViews:
- description: The pageviews for the path. This property exists only if the metrics to retrieve is "pageviews"
+ description: The number of screenPageViews for the path. This property exists only if the metrics to retrieve is "screenPageViews"
type: integer
sessions:
- description: The number of sessions for the path. This property exists only if the metrics to retrieve is "visits"
+ description: The number of sessions for the path. This property exists only if the metrics to retrieve is "sessions"
type: integer
type: object
tag:
@@ -4891,7 +5113,7 @@ externalDocs:
url: https://www.movabletype.jp/developers/data-api/
info:
title: Movable Type Data API
- version: 8.6.0
+ version: 8.7.0
openapi: 3.0.0
paths:
/:
@@ -5023,8 +5245,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Upload file size is larger than CGIMaxUpload.
- security:
- - mtauth: []
summary: Upload a file
tags:
- Assets
@@ -5246,6 +5466,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/group_dateField'
- $ref: '#/components/parameters/group_dateFrom'
- $ref: '#/components/parameters/group_dateTo'
@@ -5279,8 +5500,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to retrieve the requested groups.
- security:
- - mtauth: []
summary: Retrieve a list of groups
tags:
- Groups
@@ -5314,8 +5533,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to create a group.
- security:
- - mtauth: []
summary: Create a new group
tags:
- Groups
@@ -5345,8 +5562,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to synchronize groups.
- security:
- - mtauth: []
summary: Synchronize groups
tags:
- Groups
@@ -5395,8 +5610,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a group
tags:
- Groups
@@ -5435,8 +5648,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve single group by its ID
tags:
- Groups
@@ -5492,8 +5703,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a group
tags:
- Groups
@@ -5512,6 +5721,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/user_dateField'
- $ref: '#/components/parameters/user_dateFrom'
- $ref: '#/components/parameters/user_dateTo'
@@ -5551,8 +5761,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve a list of members for specified group
tags:
- Groups
@@ -5601,8 +5809,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group or Member not found.
- security:
- - mtauth: []
tags:
- Groups
'/groups/{group_id}/members/{member_id}':
@@ -5655,8 +5861,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
tags:
- Groups
get:
@@ -5699,8 +5903,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group or Member not found.
- security:
- - mtauth: []
summary: Retrieve single member by its ID for specified group
tags:
- Groups
@@ -5721,6 +5923,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -5760,8 +5963,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for group
tags:
- Groups
@@ -5819,8 +6020,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Group not found
- security:
- - mtauth: []
summary: Grant permissions to group
tags:
- Groups
@@ -5878,8 +6077,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Group not found
- security:
- - mtauth: []
summary: Revoke permissions from group
tags:
- Groups
@@ -5896,6 +6093,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -5935,8 +6133,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions
tags:
- Permissions
@@ -5978,8 +6174,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of plugins in the specified site
tags:
- Plugins
@@ -6015,8 +6209,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Disable all plugins
tags:
- Plugins
@@ -6052,8 +6244,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Enable all plugins
tags:
- Plugins
@@ -6092,8 +6282,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found.
- security:
- - mtauth: []
summary: Retrieve single plugin by its ID
tags:
- Plugins
@@ -6135,8 +6323,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Disable a plugin
tags:
- Plugins
@@ -6178,8 +6364,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Enable a plugin
tags:
- Plugins
@@ -6242,8 +6426,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to publish content_data.
- security:
- - mtauth: []
summary: Publish Content Data
tags:
- Content Data
@@ -6321,8 +6503,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to publish.
- security:
- - mtauth: []
summary: Rebuild the static archives in relation to specified entries
tags:
- Entries
@@ -6424,8 +6604,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to retrieve the list of roles.
- security:
- - mtauth: []
summary: Retrieve a list of roles
tags:
- Roles
@@ -6465,8 +6643,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new role
tags:
- Roles
@@ -6515,8 +6691,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing role
tags:
- Roles
@@ -6555,8 +6729,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role not found.
- security:
- - mtauth: []
summary: Retrieve a single role by its ID
tags:
- Roles
@@ -6612,8 +6784,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing role
tags:
- Roles
@@ -6637,6 +6807,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -6676,8 +6847,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions by role
tags:
- Roles
@@ -6925,8 +7094,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new website
tags:
- Sites
@@ -6981,8 +7148,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing blog or website
tags:
- Sites
@@ -7081,8 +7246,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new blog
tags:
- Sites
@@ -7143,8 +7306,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing blog or website
tags:
- Sites
@@ -7165,6 +7326,7 @@ paths:
- $ref: '#/components/parameters/asset_searchFields'
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -7336,8 +7498,6 @@ paths:
type: object
type: object
description: Conflict
- security:
- - mtauth: []
summary: Upload a file
tags:
- Assets
@@ -7396,8 +7556,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an asset
tags:
- Assets
@@ -7511,8 +7669,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an asset
tags:
- Assets
@@ -7554,6 +7710,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -7635,6 +7792,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -7794,8 +7952,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Backup specified site
tags:
- Sites
@@ -7953,8 +8109,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new category
tags:
- Categories
@@ -8016,8 +8170,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Rearrange existing categories in a new order
tags:
- Categories
@@ -8077,8 +8229,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing category
tags:
- Categories
@@ -8192,8 +8342,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing category
tags:
- Categories
@@ -8316,6 +8464,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -8688,8 +8837,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new category set
tags:
- Category Sets
@@ -8746,8 +8893,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete category set
tags:
- Category Sets
@@ -8865,8 +9010,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update category set
tags:
- Category Sets
@@ -8905,6 +9048,11 @@ paths:
- 0
- 1
type: integer
+ - $ref: '#/components/parameters/category_limit'
+ - $ref: '#/components/parameters/category_offset'
+ - $ref: '#/components/parameters/category_searchFields'
+ - $ref: '#/components/parameters/category_sortBy'
+ - $ref: '#/components/parameters/category_sortOrder'
- $ref: '#/components/parameters/category_dateField'
- $ref: '#/components/parameters/category_dateFrom'
- $ref: '#/components/parameters/category_dateTo'
@@ -9003,8 +9151,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site pr Category_set not found.
- security:
- - mtauth: []
summary: Create a new category for category set
tags:
- Categories
@@ -9078,8 +9224,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Category_set not found.
- security:
- - mtauth: []
summary: Save hierarchical categories order in category set
tags:
- Categories
@@ -9144,8 +9288,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete single category in category set
tags:
- Categories
@@ -9276,8 +9418,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update single category in category set
tags:
- Categories
@@ -9676,6 +9816,10 @@ paths:
- Future
- Spam
type: string
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -9771,8 +9915,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a comment
tags:
- Comments
@@ -9887,8 +10029,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a comment
tags:
- Comments
@@ -9908,6 +10048,7 @@ paths:
type: integer
- $ref: '#/components/parameters/content_type_limit'
- $ref: '#/components/parameters/content_type_offset'
+ - $ref: '#/components/parameters/content_type_searchFields'
- description: |
The field name for sort. You can specify one of following values.
- name
@@ -9964,8 +10105,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Content Type Collection
tags:
- Content Types
@@ -10021,8 +10160,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create Content Type
tags:
- Content Types
@@ -10081,8 +10218,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete Content Type
tags:
- Content Types
@@ -10132,8 +10267,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Fetch single Content Type
tags:
- Content Types
@@ -10199,8 +10332,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update Content Type
tags:
- Content Types
@@ -10232,6 +10363,8 @@ paths:
type: string
- $ref: '#/components/parameters/content_data_limit'
- $ref: '#/components/parameters/content_data_offset'
+ - $ref: '#/components/parameters/content_data_filterKeys'
+ - $ref: '#/components/parameters/content_data_searchFields'
- description: |
The field name for sort. You can specify one of following values.
- id
@@ -10323,6 +10456,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/content_data_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -10358,8 +10492,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Create Content Data
tags:
- Content Types
@@ -10443,8 +10575,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found
- security:
- - mtauth: []
summary: Make a preview by data
tags:
- Content Types
@@ -10511,8 +10641,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete single content data
tags:
- Content Types
@@ -10609,6 +10737,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/content_data_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -10650,8 +10779,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update Content Data
tags:
- Content Types
@@ -10740,8 +10867,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type or Content_data not found
- security:
- - mtauth: []
summary: Make a preview by id
tags:
- Content Types
@@ -10767,6 +10892,7 @@ paths:
type: integer
- $ref: '#/components/parameters/content_field_limit'
- $ref: '#/components/parameters/content_field_offset'
+ - $ref: '#/components/parameters/content_field_searchFields'
- description: |
The field name for sort. You can specify one of following values.
- name
@@ -10823,8 +10949,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Content Field Collection
tags:
- Content Fields
@@ -10886,8 +11010,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Create Content Field
tags:
- Content Types
@@ -10960,8 +11082,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Save hierarchical content field order
tags:
- Content Types
@@ -11026,8 +11146,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete Content Field
tags:
- Content Types
@@ -11083,8 +11201,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type or Content_field not found.
- security:
- - mtauth: []
summary: Fetch single Content Field
tags:
- Content Types
@@ -11158,8 +11274,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update Content Field
tags:
- Content Types
@@ -11194,6 +11308,7 @@ paths:
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_fields'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -11253,6 +11368,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/entry_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -11294,8 +11410,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new entry
tags:
- Entries
@@ -11334,8 +11448,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Export entries
tags:
- Entries
@@ -11418,8 +11530,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Import entries
tags:
- Entries
@@ -11487,8 +11597,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Entry not found
- security:
- - mtauth: []
summary: Make a preview for a entry
tags:
- Entries
@@ -11546,8 +11654,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an entry
tags:
- Entries
@@ -11643,6 +11749,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/entry_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -11690,8 +11797,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an entry
tags:
- Entries
@@ -11745,6 +11850,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_sortOrder'
- $ref: '#/components/parameters/asset_fields'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- $ref: '#/components/parameters/asset_dateField'
- $ref: '#/components/parameters/asset_dateFrom'
- $ref: '#/components/parameters/asset_dateTo'
@@ -11950,6 +12057,10 @@ paths:
name: offset
schema:
type: integer
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -12044,8 +12155,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Create a new comment on an entry
tags:
- Comments
@@ -12107,8 +12216,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Reply to specified comment
tags:
- Comments
@@ -12183,8 +12290,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Entry not found
- security:
- - mtauth: []
summary: Make a preview for a entry with existing data
tags:
- Entries
@@ -12233,8 +12338,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found
- security:
- - mtauth: []
summary: Export site's theme
tags:
- Themes
@@ -12253,6 +12356,7 @@ paths:
- $ref: '#/components/parameters/field_sortBy'
- $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/field_fields'
+ - $ref: '#/components/parameters/field_filterKeys'
- $ref: '#/components/parameters/field_dateField'
- $ref: '#/components/parameters/field_dateFrom'
- $ref: '#/components/parameters/field_dateTo'
@@ -12292,8 +12396,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of fields in the specified site
tags:
- CustomFields
@@ -12339,8 +12441,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new field
tags:
- CustomFields
@@ -12394,8 +12494,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a field
tags:
- CustomFields
@@ -12439,8 +12537,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Field not found.
- security:
- - mtauth: []
summary: Retrieve single field by its ID
tags:
- CustomFields
@@ -12501,8 +12597,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a field
tags:
- CustomFields
@@ -12655,8 +12749,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new folder.
tags:
- Folders
@@ -12718,8 +12810,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Rearrange existing folders in a new order
tags:
- Folders
@@ -12779,8 +12869,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing folder
tags:
- Folders
@@ -12894,8 +12982,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing folder
tags:
- Folders
@@ -13013,6 +13099,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -13294,8 +13381,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of formatted_texts in the specified site
tags:
- FormattedText
@@ -13341,8 +13426,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new formatted_text
tags:
- FormattedText
@@ -13396,8 +13479,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a formatted_text
tags:
- FormattedText
@@ -13441,8 +13522,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or FormattedText not found.
- security:
- - mtauth: []
summary: Retrieve single formatted_text by its ID
tags:
- FormattedText
@@ -13503,8 +13582,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a formatted_text
tags:
- FormattedText
@@ -13556,8 +13633,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Reset logs
tags:
- Logs
@@ -13579,6 +13654,7 @@ paths:
- $ref: '#/components/parameters/log_searchFields'
- $ref: '#/components/parameters/log_limit'
- $ref: '#/components/parameters/log_offset'
+ - $ref: '#/components/parameters/log_filterKeys'
- description: |
- id
- created_on
@@ -13669,8 +13745,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of logs in the specified site
tags:
- Logs
@@ -13716,8 +13790,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new log
tags:
- Logs
@@ -13760,8 +13832,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Export logs
tags:
- Logs
@@ -13815,8 +13885,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing log
tags:
- Logs
@@ -13860,8 +13928,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Log not found.
- security:
- - mtauth: []
summary: Retrieve a single log by its ID
tags:
- Logs
@@ -13922,8 +13988,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing log
tags:
- Logs
@@ -13960,6 +14024,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -14019,6 +14084,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/page_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -14060,8 +14126,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new page
tags:
- Pages
@@ -14129,8 +14193,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Page not found
- security:
- - mtauth: []
summary: Make a preview for a page
tags:
- Pages
@@ -14189,8 +14251,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing page
tags:
- Pages
@@ -14268,6 +14328,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/page_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -14315,8 +14376,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing page
tags:
- Pages
@@ -14340,6 +14399,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -14443,6 +14504,10 @@ paths:
name: offset
schema:
type: integer
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -14537,8 +14602,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Create a new comment on a page
tags:
- Comments
@@ -14600,8 +14663,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Reply to specified comment
tags:
- Comments
@@ -14676,8 +14737,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Page not found
- security:
- - mtauth: []
summary: Make a preview for a page with existing data
tags:
- Pages
@@ -14741,8 +14800,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for site
tags:
- Sites
@@ -14800,8 +14857,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Grant permissions to site
tags:
- Sites
@@ -14859,8 +14914,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Revoke permissions from site
tags:
- Sites
@@ -14929,8 +14982,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Reset all templates in the site
tags:
- Templates
@@ -14946,14 +14997,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -14976,7 +15027,7 @@ paths:
name: path
schema:
type: string
- - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
+ - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
in: query
name: uniquePath
schema:
@@ -15001,7 +15052,7 @@ paths:
totals:
properties:
screenPageViews:
- description: The sum total of the pageviews in the specified period.
+ description: The sum total of the screenPageViews in the specified period.
type: integer
type: object
type: object
@@ -15024,8 +15075,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve pageviews count for each date from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -15041,14 +15090,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -15111,8 +15160,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve visits count for each date from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -15128,14 +15175,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -15158,7 +15205,7 @@ paths:
name: path
schema:
type: string
- - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
+ - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
in: query
name: uniquePath
schema:
@@ -15183,7 +15230,7 @@ paths:
totals:
properties:
screenPageViews:
- description: The sum total of the pageviews in the specified period.
+ description: The sum total of the screenPageViews in the specified period.
type: integer
type: object
type: object
@@ -15206,8 +15253,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve pageviews count for each path from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -15223,14 +15268,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -15293,8 +15338,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve visits count for each path from provider (e.g. Google Analytics)
tags:
- Statistics
@@ -15338,8 +15381,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Retrieve a current effective provider
tags:
- Statistics
@@ -15450,8 +15491,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing tag
tags:
- Tags
@@ -15555,8 +15594,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing tag
tags:
- Tags
@@ -15580,6 +15617,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -15689,6 +15728,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -15770,6 +15810,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -15831,6 +15872,7 @@ paths:
- $ref: '#/components/parameters/template_searchFields'
- $ref: '#/components/parameters/template_limit'
- $ref: '#/components/parameters/template_offset'
+ - $ref: '#/components/parameters/template_filterKeys'
- description: |
#### id
@@ -15922,8 +15964,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of templates in the specified site
tags:
- Templates
@@ -15940,6 +15980,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/template_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -15975,8 +16016,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new template
tags:
- Templates
@@ -16045,8 +16084,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Make a preview for a template
tags:
- Templates
@@ -16105,8 +16142,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a template
tags:
- Templates
@@ -16156,8 +16191,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Retrieve single template by its ID
tags:
- Templates
@@ -16182,6 +16215,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/template_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -16223,8 +16257,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a template
tags:
- Templates
@@ -16277,8 +16309,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Make a clone of a template
tags:
- Templates
@@ -16358,8 +16388,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Make a preview for a template with existing data
tags:
- Templates
@@ -16418,8 +16446,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Publish a template
tags:
- Templates
@@ -16476,8 +16502,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Reset template text to theme default or tempalte_set default
tags:
- Templates
@@ -16503,6 +16527,7 @@ paths:
- $ref: '#/components/parameters/templatemap_fields'
- $ref: '#/components/parameters/templatemap_includeIds'
- $ref: '#/components/parameters/templatemap_excludeIds'
+ - $ref: '#/components/parameters/templatemap_filterKeys'
- $ref: '#/components/parameters/templatemap_dateField'
- $ref: '#/components/parameters/templatemap_dateFrom'
- $ref: '#/components/parameters/templatemap_dateTo'
@@ -16542,8 +16567,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Retrieve a list of templatemaps in the specified site
tags:
- Templates
@@ -16595,8 +16618,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Create a new templatemap
tags:
- Templates
@@ -16656,8 +16677,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing templatemap
tags:
- Templates
@@ -16706,8 +16725,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template or TemplateMap not found.
- security:
- - mtauth: []
summary: Retrieve a single templatemap by its ID
tags:
- Templates
@@ -16774,8 +16791,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing templatemap
tags:
- Templates
@@ -16830,8 +16845,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of themes for site
tags:
- Themes
@@ -16881,8 +16894,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found.
- security:
- - mtauth: []
summary: Retrieve a single theme by its ID for site
tags:
- Themes
@@ -16935,8 +16946,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found
- security:
- - mtauth: []
summary: Apply a theme to site
tags:
- Themes
@@ -16996,8 +17005,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgets in the specified site
tags:
- Widgets
@@ -17043,8 +17050,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new widget
tags:
- Widgets
@@ -17098,8 +17103,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a widget
tags:
- Widgets
@@ -17143,8 +17146,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found.
- security:
- - mtauth: []
summary: Retrieve a single widget by its ID
tags:
- Widgets
@@ -17205,8 +17206,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a widget
tags:
- Widgets
@@ -17253,8 +17252,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found
- security:
- - mtauth: []
summary: Make a clone of a widget
tags:
- Widgets
@@ -17305,8 +17302,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found
- security:
- - mtauth: []
summary: Reset widget text to default
tags:
- Widgets
@@ -17366,8 +17361,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgetsets in the specified site
tags:
- WidgetSets
@@ -17413,8 +17406,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new widgetset
tags:
- WidgetSets
@@ -17468,8 +17459,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing widgetset
tags:
- WidgetSets
@@ -17513,8 +17502,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or WidgetSet not found.
- security:
- - mtauth: []
summary: Retrieve a single widgetset by its ID
tags:
- WidgetSets
@@ -17575,8 +17562,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing widgetset
tags:
- WidgetSets
@@ -17641,8 +17626,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or WidgetSet not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgets in the specified widgetset
tags:
- Widgets
@@ -17693,8 +17676,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found.
- security:
- - mtauth: []
summary: Retrieve a single widget by widgetset ID
tags:
- Widgets
@@ -17783,8 +17764,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of themes
tags:
- Themes
@@ -17839,8 +17818,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Uninstall a specified theme from the MT
tags:
- Themes
@@ -17884,8 +17861,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found.
- security:
- - mtauth: []
summary: Retrieve a single theme by its ID
tags:
- Themes
@@ -17927,8 +17902,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Invalidate current session. This is like logout
tags:
- Authentication
@@ -18005,6 +17978,7 @@ paths:
- $ref: '#/components/parameters/user_searchFields'
- $ref: '#/components/parameters/user_limit'
- $ref: '#/components/parameters/user_offset'
+ - $ref: '#/components/parameters/user_filterKeys'
- description: |
The field name for sort. You can specify one of following values
- id
@@ -18146,8 +18120,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new user
tags:
- Users
@@ -18174,8 +18146,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to export users.
- security:
- - mtauth: []
summary: Export users
tags:
- Users
@@ -18220,8 +18190,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to import users.
- security:
- - mtauth: []
summary: Import users
tags:
- Users
@@ -18251,8 +18219,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to synchronize users.
- security:
- - mtauth: []
summary: Synchronize users
tags:
- Users
@@ -18307,8 +18273,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete user
tags:
- Users
@@ -18418,8 +18382,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update user data
tags:
- Users
@@ -18438,6 +18400,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/group_dateField'
- $ref: '#/components/parameters/group_dateFrom'
- $ref: '#/components/parameters/group_dateTo'
@@ -18477,8 +18440,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: User not found.
- security:
- - mtauth: []
summary: Retrieve a list of groups
tags:
- Users
@@ -18500,6 +18461,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -18539,8 +18501,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for user
tags:
- Users
@@ -18598,8 +18558,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Grant permissions to user
tags:
- Users
@@ -18657,8 +18615,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Revoke permissions from user
tags:
- Users
@@ -18709,8 +18665,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found
- security:
- - mtauth: []
summary: Send the link for password recovery to specified user by email
tags:
- Users
@@ -18874,8 +18828,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found
- security:
- - mtauth: []
summary: Unlock user account
tags:
- Users
@@ -18916,6 +18868,8 @@ paths:
summary: Get server API version
tags:
- Common API
+security:
+ - mtauth: []
servers:
- url: https://example.com/mt/mt-data-api.cgi/v6
tags:
diff --git a/src/openapi/v7.json b/src/openapi/v7.json
index 2bd89d1..3fb874b 100644
--- a/src/openapi/v7.json
+++ b/src/openapi/v7.json
@@ -42,6 +42,15 @@
"type": "string"
}
},
+ "asset_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: class",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "class",
+ "type": "string"
+ }
+ },
"asset_includeIds": {
"description": "The comma separated ID list of assets to include to result.",
"in": "query",
@@ -148,6 +157,14 @@
"type": "string"
}
},
+ "category_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"category_includeIds": {
"description": "The comma separated ID list of categories to include to result.",
"in": "query",
@@ -232,6 +249,14 @@
"type": "string"
}
},
+ "category_set_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"category_set_includeIds": {
"description": "The comma separated ID list of category_sets to include to result.",
"in": "query",
@@ -360,6 +385,15 @@
"type": "string"
}
},
+ "comment_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"comment_includeIds": {
"description": "The comma separated ID list of comments to include to result.",
"in": "query",
@@ -466,6 +500,15 @@
"type": "string"
}
},
+ "content_data_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"content_data_includeIds": {
"description": "The comma separated ID list of content_data to include to result.",
"in": "query",
@@ -492,6 +535,18 @@
"type": "integer"
}
},
+ "content_data_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"content_data_search": {
"description": "Search query.",
"in": "query",
@@ -572,6 +627,14 @@
"type": "string"
}
},
+ "content_field_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"content_field_includeIds": {
"description": "The comma separated ID list of content_fields to include to result.",
"in": "query",
@@ -678,6 +741,14 @@
"type": "string"
}
},
+ "content_type_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"content_type_includeIds": {
"description": "The comma separated ID list of content_types to include to result.",
"in": "query",
@@ -784,6 +855,15 @@
"type": "string"
}
},
+ "entry_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"entry_includeIds": {
"description": "The comma separated ID list of entries to include to result.",
"in": "query",
@@ -838,6 +918,18 @@
"type": "integer"
}
},
+ "entry_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"entry_search": {
"description": "Search query.",
"in": "query",
@@ -940,6 +1032,15 @@
"type": "string"
}
},
+ "field_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: systemObject,type",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "systemObject,type",
+ "type": "string"
+ }
+ },
"field_includeIds": {
"description": "The comma separated ID list of fields to include to result.",
"in": "query",
@@ -1046,6 +1147,14 @@
"type": "string"
}
},
+ "folder_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"folder_includeIds": {
"description": "The comma separated ID list of folders to include to result.",
"in": "query",
@@ -1152,6 +1261,14 @@
"type": "string"
}
},
+ "formatted_text_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"formatted_text_includeIds": {
"description": "The comma separated ID list of formatted_texts to include to result.",
"in": "query",
@@ -1258,6 +1375,15 @@
"type": "string"
}
},
+ "group_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"group_includeIds": {
"description": "The comma separated ID list of groups to include to result.",
"in": "query",
@@ -1364,6 +1490,15 @@
"type": "string"
}
},
+ "log_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: level",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "level",
+ "type": "string"
+ }
+ },
"log_includeIds": {
"description": "The comma separated ID list of logs to include to result.",
"in": "query",
@@ -1470,6 +1605,15 @@
"type": "string"
}
},
+ "page_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status",
+ "type": "string"
+ }
+ },
"page_includeIds": {
"description": "The comma separated ID list of pages to include to result.",
"in": "query",
@@ -1524,6 +1668,18 @@
"type": "integer"
}
},
+ "page_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"page_search": {
"description": "Search query.",
"in": "query",
@@ -1634,6 +1790,15 @@
"type": "string"
}
},
+ "permission_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: blogIds",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "blogIds",
+ "type": "string"
+ }
+ },
"permission_includeIds": {
"description": "The comma separated ID list of permissions to include to result.",
"in": "query",
@@ -1746,6 +1911,14 @@
"type": "string"
}
},
+ "role_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"role_includeIds": {
"description": "The comma separated ID list of roles to include to result.",
"in": "query",
@@ -1859,6 +2032,14 @@
"type": "string"
}
},
+ "site_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"site_includeIds": {
"description": "The comma separated ID list of sites to include to result.",
"in": "query",
@@ -1968,6 +2149,14 @@
"type": "string"
}
},
+ "tag_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"tag_includeIds": {
"description": "The comma separated ID list of tags to include to result.",
"in": "query",
@@ -2074,6 +2263,15 @@
"type": "string"
}
},
+ "template_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: type",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "type",
+ "type": "string"
+ }
+ },
"template_includeIds": {
"description": "The comma separated ID list of templates to include to result.",
"in": "query",
@@ -2100,6 +2298,18 @@
"type": "integer"
}
},
+ "template_saveRevision": {
+ "description": "Save a revision or not",
+ "in": "query",
+ "name": "saveRevision",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ },
"template_search": {
"description": "Search query.",
"in": "query",
@@ -2180,6 +2390,15 @@
"type": "string"
}
},
+ "templatemap_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: archiveType,buildType,isPreferred",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "archiveType,buildType,isPreferred",
+ "type": "string"
+ }
+ },
"templatemap_includeIds": {
"description": "The comma separated ID list of templatemaps to include to result.",
"in": "query",
@@ -2285,6 +2504,15 @@
"type": "string"
}
},
+ "user_filterKeys": {
+ "description": "The comma separated field name list to filter.\n\n**Default**: status,lockout",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "default": "status,lockout",
+ "type": "string"
+ }
+ },
"user_includeIds": {
"description": "The comma separated ID list of users to include to result.",
"in": "query",
@@ -2391,6 +2619,14 @@
"type": "string"
}
},
+ "widget_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"widget_includeIds": {
"description": "The comma separated ID list of widgets to include to result.",
"in": "query",
@@ -2497,6 +2733,14 @@
"type": "string"
}
},
+ "widgetset_filterKeys": {
+ "description": "The comma separated field name list to filter.",
+ "in": "query",
+ "name": "filterKeys",
+ "schema": {
+ "type": "string"
+ }
+ },
"widgetset_includeIds": {
"description": "The comma separated ID list of widgetsets to include to result.",
"in": "query",
@@ -5137,11 +5381,11 @@
"type": "string"
},
"screenPageViews": {
- "description": "The pageviews for the path. This property exists only if the metrics to retrieve is \"pageviews\"",
+ "description": "The number of screenPageViews for the path. This property exists only if the metrics to retrieve is \"screenPageViews\"",
"type": "integer"
},
"sessions": {
- "description": "The number of sessions for the path. This property exists only if the metrics to retrieve is \"visits\"",
+ "description": "The number of sessions for the path. This property exists only if the metrics to retrieve is \"sessions\"",
"type": "integer"
}
},
@@ -5192,12 +5436,63 @@
"type": "string"
},
"screenPageViews": {
- "description": "The pageviews for the path. This property exists only if the metrics to retrieve is \"pageviews\"",
+ "description": "The pageviews for the path. This property exists only if the metrics to retrieve is \"screenPageViews\"",
+ "type": "integer"
+ },
+ "sessions": {
+ "description": "The number of sessions for the path. This property exists only if the metrics to retrieve is \"sessions\"",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "statisticsyear": {
+ "properties": {
+ "screenPageViews": {
+ "description": "The number of screenPageViews for the path. This property exists only if the metrics to retrieve is \"screenPageViews\"",
+ "type": "integer"
+ },
+ "sessions": {
+ "description": "The number of sessions for the path. This property exists only if the metrics to retrieve is \"sessions\"",
+ "type": "integer"
+ },
+ "year": {
+ "description": "The year of the target. The format is \"YYYY\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "statisticsyearmonth": {
+ "properties": {
+ "screenPageViews": {
+ "description": "The number of screenPageViews for the path. This property exists only if the metrics to retrieve is \"screenPageViews\"",
+ "type": "integer"
+ },
+ "sessions": {
+ "description": "The number of sessions for the path. This property exists only if the metrics to retrieve is \"sessions\"",
+ "type": "integer"
+ },
+ "yearMonth": {
+ "description": "The year and month of the target. The format is \"YYYY-MM\".",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "statisticsyearweek": {
+ "properties": {
+ "screenPageViews": {
+ "description": "The number of screenPageViews for the path. This property exists only if the metrics to retrieve is \"screenPageViews\"",
"type": "integer"
},
"sessions": {
- "description": "The number of sessions for the path. This property exists only if the metrics to retrieve is \"visits\"",
+ "description": "The number of sessions for the path. This property exists only if the metrics to retrieve is \"sessions\"",
"type": "integer"
+ },
+ "yearWeek": {
+ "description": "The year and week of the target. The format is \"YYYY-Www\".",
+ "type": "string"
}
},
"type": "object"
@@ -6182,7 +6477,7 @@
},
"info": {
"title": "Movable Type Data API",
- "version": "8.6.0"
+ "version": "8.7.0"
},
"openapi": "3.0.0",
"paths": {
@@ -6386,11 +6681,6 @@
"description": "Upload file size is larger than CGIMaxUpload."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Upload a file",
"tags": [
"Assets"
@@ -6730,6 +7020,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/group_dateField"
},
@@ -6788,11 +7081,6 @@
"description": "Do not have permission to retrieve the requested groups."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of groups",
"tags": [
"Groups"
@@ -6848,11 +7136,6 @@
"description": "Do not have permission to create a group."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new group",
"tags": [
"Groups"
@@ -6901,11 +7184,6 @@
"description": "Do not have permission to synchronize groups."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Synchronize groups",
"tags": [
"Groups"
@@ -6980,11 +7258,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a group",
"tags": [
"Groups"
@@ -7049,11 +7322,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single group by its ID",
"tags": [
"Groups"
@@ -7140,11 +7408,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a group",
"tags": [
"Groups"
@@ -7183,6 +7446,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/user_dateField"
},
@@ -7251,11 +7517,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of members for specified group",
"tags": [
"Groups"
@@ -7336,11 +7597,6 @@
"description": "Group or Member not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"tags": [
"Groups"
]
@@ -7422,11 +7678,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"tags": [
"Groups"
]
@@ -7498,11 +7749,6 @@
"description": "Group or Member not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single member by its ID for specified group",
"tags": [
"Groups"
@@ -7539,6 +7785,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -7607,11 +7856,6 @@
"description": "Group not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for group",
"tags": [
"Groups",
@@ -7701,11 +7945,6 @@
"description": "Site or Group not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to group",
"tags": [
"Groups",
@@ -7795,11 +8034,6 @@
"description": "Site or Group not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from group",
"tags": [
"Groups",
@@ -7829,6 +8063,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -7897,11 +8134,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions",
"tags": [
"Permissions"
@@ -7968,11 +8200,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of plugins in the specified site",
"tags": [
"Plugins"
@@ -8031,11 +8258,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Disable all plugins",
"tags": [
"Plugins"
@@ -8094,11 +8316,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Enable all plugins",
"tags": [
"Plugins"
@@ -8162,11 +8379,6 @@
"description": "Site or Plugin not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single plugin by its ID",
"tags": [
"Plugins"
@@ -8235,11 +8447,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Disable a plugin",
"tags": [
"Plugins"
@@ -8308,11 +8515,6 @@
"description": "Site or Plugin not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Enable a plugin",
"tags": [
"Plugins"
@@ -8405,11 +8607,6 @@
"description": "Do not have permission to publish content_data."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Publish Content Data",
"tags": [
"Content Data",
@@ -8508,11 +8705,6 @@
"description": "Do not have permission to publish."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rebuild the static archives in relation to specified entries",
"tags": [
"Entries",
@@ -8680,11 +8872,6 @@
"description": "Do not have permission to retrieve the list of roles."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of roles",
"tags": [
"Roles"
@@ -8750,11 +8937,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new role",
"tags": [
"Roles"
@@ -8829,11 +9011,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing role",
"tags": [
"Roles"
@@ -8898,11 +9075,6 @@
"description": "Site or Role not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single role by its ID",
"tags": [
"Roles"
@@ -8989,11 +9161,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing role",
"tags": [
"Roles"
@@ -9030,6 +9197,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -9098,11 +9268,6 @@
"description": "Site or Role not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions by role",
"tags": [
"Roles",
@@ -9436,11 +9601,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new website",
"tags": [
"Sites"
@@ -9515,11 +9675,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing blog or website",
"tags": [
"Sites"
@@ -9673,11 +9828,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new blog",
"tags": [
"Sites"
@@ -9764,11 +9914,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing blog or website",
"tags": [
"Sites"
@@ -9806,6 +9951,9 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -10051,11 +10199,6 @@
"description": "Conflict"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Upload a file",
"tags": [
"Assets"
@@ -10138,11 +10281,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an asset",
"tags": [
"Assets"
@@ -10317,11 +10455,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an asset",
"tags": [
"Assets"
@@ -10395,6 +10528,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -10537,6 +10673,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -10799,11 +10938,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Backup specified site",
"tags": [
"Sites",
@@ -11025,11 +11159,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new category",
"tags": [
"Categories"
@@ -11113,11 +11242,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rearrange existing categories in a new order",
"tags": [
"Categories"
@@ -11200,11 +11324,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing category",
"tags": [
"Categories"
@@ -11379,11 +11498,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing category",
"tags": [
"Categories"
@@ -11568,6 +11682,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -12108,11 +12225,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new category set",
"tags": [
"Category Sets"
@@ -12195,11 +12307,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete category set",
"tags": [
"Category Sets"
@@ -12375,11 +12482,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update category set",
"tags": [
"Category Sets"
@@ -12435,6 +12537,21 @@
"type": "integer"
}
},
+ {
+ "$ref": "#/components/parameters/category_limit"
+ },
+ {
+ "$ref": "#/components/parameters/category_offset"
+ },
+ {
+ "$ref": "#/components/parameters/category_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/category_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/category_sortOrder"
+ },
{
"$ref": "#/components/parameters/category_dateField"
},
@@ -12586,11 +12703,6 @@
"description": "Site pr Category_set not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new category for category set",
"tags": [
"Categories",
@@ -12683,11 +12795,6 @@
"description": "Site or Category_set not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Save hierarchical categories order in category set",
"tags": [
"Categories",
@@ -12779,11 +12886,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete single category in category set",
"tags": [
"Categories",
@@ -12977,11 +13079,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update single category in category set",
"tags": [
"Categories",
@@ -13593,6 +13690,18 @@
"type": "string"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -13743,11 +13852,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a comment",
"tags": [
"Comments"
@@ -13920,11 +14024,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a comment",
"tags": [
"Comments"
@@ -13949,6 +14048,9 @@
{
"$ref": "#/components/parameters/content_type_offset"
},
+ {
+ "$ref": "#/components/parameters/content_type_searchFields"
+ },
{
"description": "The field name for sort. You can specify one of following values.\n- name\n- dataLabel\n- uniqueID\n- modified_on\n",
"in": "query",
@@ -14041,11 +14143,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Content Type Collection",
"tags": [
"Content Types"
@@ -14122,11 +14219,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create Content Type",
"tags": [
"Content Types"
@@ -14209,11 +14301,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete Content Type",
"tags": [
"Content Types"
@@ -14287,11 +14374,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Fetch single Content Type",
"tags": [
"Content Types"
@@ -14386,11 +14468,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update Content Type",
"tags": [
"Content Types"
@@ -14431,6 +14508,12 @@
{
"$ref": "#/components/parameters/content_data_offset"
},
+ {
+ "$ref": "#/components/parameters/content_data_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/content_data_searchFields"
+ },
{
"description": "The field name for sort. You can specify one of following values.\n- id\n- uniqueID\n- authored_on\n- created_on\n- modified_on\n",
"in": "query",
@@ -14552,6 +14635,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/content_data_saveRevision"
}
],
"requestBody": {
@@ -14613,11 +14699,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create Content Data",
"tags": [
"Content Types",
@@ -14726,11 +14807,6 @@
"description": "Site or Content_type not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview by data",
"tags": [
"Content Types",
@@ -14822,11 +14898,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete single content data",
"tags": [
"Content Types",
@@ -14949,6 +15020,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/content_data_saveRevision"
}
],
"requestBody": {
@@ -15020,11 +15094,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update Content Data",
"tags": [
"Content Types",
@@ -15141,11 +15210,6 @@
"description": "Site or Content_type or Content_data not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview by id",
"tags": [
"Content Types",
@@ -15179,6 +15243,9 @@
{
"$ref": "#/components/parameters/content_field_offset"
},
+ {
+ "$ref": "#/components/parameters/content_field_searchFields"
+ },
{
"description": "The field name for sort. You can specify one of following values.\n- name\n- dataLabel\n- uniqueID\n- modified_on\n",
"in": "query",
@@ -15271,11 +15338,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Content Field Collection",
"tags": [
"Content Fields",
@@ -15361,11 +15423,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create Content Field",
"tags": [
"Content Types",
@@ -15458,11 +15515,6 @@
"description": "Site or Content_type not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Save hierarchical content field order",
"tags": [
"Content Types",
@@ -15554,11 +15606,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete Content Field",
"tags": [
"Content Types",
@@ -15641,11 +15688,6 @@
"description": "Site or Content_type or Content_field not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Fetch single Content Field",
"tags": [
"Content Types",
@@ -15749,11 +15791,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update Content Field",
"tags": [
"Content Types",
@@ -15820,6 +15857,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -15903,6 +15943,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_saveRevision"
}
],
"requestBody": {
@@ -15972,11 +16015,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new entry",
"tags": [
"Entries"
@@ -16040,11 +16078,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export entries",
"tags": [
"Entries"
@@ -16160,11 +16193,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Import entries",
"tags": [
"Entries"
@@ -16264,11 +16292,6 @@
"description": "Site or Entry not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a entry",
"tags": [
"Entries"
@@ -16351,11 +16374,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an entry",
"tags": [
"Entries"
@@ -16481,6 +16499,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/entry_saveRevision"
}
],
"requestBody": {
@@ -16560,11 +16581,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an entry",
"tags": [
"Entries"
@@ -16632,6 +16648,12 @@
{
"$ref": "#/components/parameters/asset_fields"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"$ref": "#/components/parameters/asset_dateField"
},
@@ -16914,6 +16936,18 @@
"type": "integer"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -17067,11 +17101,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new comment on an entry",
"tags": [
"Comments",
@@ -17167,11 +17196,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reply to specified comment",
"tags": [
"Comments",
@@ -17280,11 +17304,6 @@
"description": "Site or Entry not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a entry with existing data",
"tags": [
"Entries"
@@ -17429,11 +17448,6 @@
"description": "Site or Theme not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export site's theme",
"tags": [
"Themes"
@@ -17472,6 +17486,9 @@
{
"$ref": "#/components/parameters/field_fields"
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
{
"$ref": "#/components/parameters/field_dateField"
},
@@ -17540,11 +17557,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of fields in the specified site",
"tags": [
"CustomFields"
@@ -17620,11 +17632,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new field",
"tags": [
"CustomFields"
@@ -17707,11 +17714,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a field",
"tags": [
"CustomFields"
@@ -17784,11 +17786,6 @@
"description": "Site or Field not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single field by its ID",
"tags": [
"CustomFields"
@@ -17883,11 +17880,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a field",
"tags": [
"CustomFields"
@@ -18099,11 +18091,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new folder.",
"tags": [
"Folders"
@@ -18187,11 +18174,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Rearrange existing folders in a new order",
"tags": [
"Folders"
@@ -18274,11 +18256,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing folder",
"tags": [
"Folders"
@@ -18453,11 +18430,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing folder",
"tags": [
"Folders"
@@ -18633,6 +18605,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -19059,11 +19034,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of formatted_texts in the specified site",
"tags": [
"FormattedText"
@@ -19139,11 +19109,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new formatted_text",
"tags": [
"FormattedText"
@@ -19226,11 +19191,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a formatted_text",
"tags": [
"FormattedText"
@@ -19303,11 +19263,6 @@
"description": "Site or FormattedText not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single formatted_text by its ID",
"tags": [
"FormattedText"
@@ -19402,11 +19357,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a formatted_text",
"tags": [
"FormattedText"
@@ -19486,11 +19436,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset logs",
"tags": [
"Logs"
@@ -19519,6 +19464,9 @@
{
"$ref": "#/components/parameters/log_offset"
},
+ {
+ "$ref": "#/components/parameters/log_filterKeys"
+ },
{
"description": "- id\n- created_on\n- blog_id\n- author_id\n- level\n- class\n\n**Default**: created_on\n",
"in": "query",
@@ -19635,11 +19583,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of logs in the specified site",
"tags": [
"Logs"
@@ -19715,11 +19658,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new log",
"tags": [
"Logs"
@@ -19790,11 +19728,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export logs",
"tags": [
"Logs"
@@ -19877,11 +19810,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing log",
"tags": [
"Logs"
@@ -19954,11 +19882,6 @@
"description": "Site or Log not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single log by its ID",
"tags": [
"Logs"
@@ -20053,11 +19976,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing log",
"tags": [
"Logs"
@@ -20123,6 +20041,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -20206,6 +20127,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/page_saveRevision"
}
],
"requestBody": {
@@ -20275,11 +20199,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new page",
"tags": [
"Pages"
@@ -20379,11 +20298,6 @@
"description": "Site or Page not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a page",
"tags": [
"Pages"
@@ -20466,11 +20380,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing page",
"tags": [
"Pages"
@@ -20575,6 +20484,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/page_saveRevision"
}
],
"requestBody": {
@@ -20654,11 +20566,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing page",
"tags": [
"Pages"
@@ -20698,6 +20605,12 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -20843,6 +20756,18 @@
"type": "integer"
}
},
+ {
+ "$ref": "#/components/parameters/field_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/field_searchFields"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortBy"
+ },
+ {
+ "$ref": "#/components/parameters/field_sortOrder"
+ },
{
"$ref": "#/components/parameters/comment_dateField"
},
@@ -20996,11 +20921,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new comment on a page",
"tags": [
"Comments",
@@ -21096,11 +21016,6 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reply to specified comment",
"tags": [
"Comments",
@@ -21209,11 +21124,6 @@
"description": "Site or Page not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a page with existing data",
"tags": [
"Pages"
@@ -21315,11 +21225,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for site",
"tags": [
"Sites",
@@ -21409,11 +21314,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to site",
"tags": [
"Sites",
@@ -21503,11 +21403,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from site",
"tags": [
"Sites",
@@ -21591,11 +21486,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset all templates in the site",
"tags": [
"Templates"
@@ -21604,7 +21494,7 @@
},
"/sites/{site_id}/stats/date/pageviews": {
"get": {
- "description": "Retrieve pageviews count for each date from provider (e.g. Google Analytics).\n\nAuthorization is required.\n",
+ "description": "Retrieve screenPageViews count for each date from provider (e.g. Google Analytics V4).\n\nAuthorization is required.\n",
"parameters": [
{
"in": "path",
@@ -21615,7 +21505,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -21625,7 +21515,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -21654,13 +21544,13 @@
{
"description": "This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.",
"in": "query",
- "name": "path",
+ "name": "pagePath",
"schema": {
"type": "string"
}
},
{
- "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "description": "This is an optional parameter. If true is given, the MT can return total screenPageViews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another screenPageViews by same path.)",
"in": "query",
"name": "uniquePath",
"schema": {
@@ -21692,7 +21582,7 @@
"totals": {
"properties": {
"screenPageViews": {
- "description": "The sum total of the pageviews in the specified period.",
+ "description": "The sum total of the screenPageViews in the specified period.",
"type": "integer"
}
},
@@ -21736,20 +21626,15 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
- "summary": "Retrieve pageviews count for each date from provider (e.g. Google Analytics)",
+ "summary": "Retrieve screenPageViews count for each date from provider (e.g. Google Analytics V4)",
"tags": [
"Statistics"
]
}
},
- "/sites/{site_id}/stats/date/visits": {
+ "/sites/{site_id}/stats/date/screenPageViews": {
"get": {
- "description": "Retrieve visits count for each date from provider (e.g. Google Analytics).\n\nAuthorization is required.\n",
+ "description": "Retrieve screenPageViews count for each date from provider (e.g. Google Analytics V4).\n\nAuthorization is required.\n",
"parameters": [
{
"in": "path",
@@ -21760,7 +21645,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -21770,7 +21655,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -21799,10 +21684,22 @@
{
"description": "This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.",
"in": "query",
- "name": "path",
+ "name": "pagePath",
"schema": {
"type": "string"
}
+ },
+ {
+ "description": "This is an optional parameter. If true is given, the MT can return total screenPageViews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another screenPageViews by same path.)",
+ "in": "query",
+ "name": "uniquePath",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
}
],
"responses": {
@@ -21824,8 +21721,8 @@
},
"totals": {
"properties": {
- "sessions": {
- "description": "The sum total of the sessions in the specified period.",
+ "screenPageViews": {
+ "description": "The sum total of the screenPageViews in the specified period.",
"type": "integer"
}
},
@@ -21869,20 +21766,15 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
- "summary": "Retrieve visits count for each date from provider (e.g. Google Analytics)",
+ "summary": "Retrieve screenPageViews count for each date from provider (e.g. Google Analytics V4)",
"tags": [
"Statistics"
]
}
},
- "/sites/{site_id}/stats/path/pageviews": {
+ "/sites/{site_id}/stats/date/sessions": {
"get": {
- "description": "Retrieve pageviews count for each path from provider (e.g. Google Analytics).\n\nAuthorization is required.\n",
+ "description": "Retrieve sessions count for each date from provider (e.g. Google Analytics V4).\n\nAuthorization is required.\n",
"parameters": [
{
"in": "path",
@@ -21893,7 +21785,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -21903,7 +21795,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -21932,22 +21824,138 @@
{
"description": "This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.",
"in": "query",
- "name": "path",
+ "name": "pagePath",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "description": "An array of Items for date resource.",
+ "items": {
+ "$ref": "#/components/schemas/statisticsdate"
+ },
+ "type": "array"
+ },
+ "totalResults": {
+ "description": "The total number of paths.",
+ "type": "integer"
+ },
+ "totals": {
+ "properties": {
+ "sessions": {
+ "description": "The sum total of the sessions in the specified period.",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "400": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Bad request"
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Invalid login"
+ },
+ "404": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Not Found"
+ }
+ },
+ "summary": "Retrieve sessions count for each date from provider (e.g. Google Analytics V4)",
+ "tags": [
+ "Statistics"
+ ]
+ }
+ },
+ "/sites/{site_id}/stats/date/visits": {
+ "get": {
+ "description": "Retrieve sessions count for each date from provider (e.g. Google Analytics V4).\n\nAuthorization is required.\n",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "site_id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "startDate",
+ "required": true,
"schema": {
+ "format": "date",
"type": "string"
}
},
{
- "description": "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
- "name": "uniquePath",
+ "name": "endDate",
+ "required": true,
"schema": {
- "enum": [
- 0,
- 1
- ],
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. Maximum number of paths to retrieve. Default is 50.",
+ "in": "query",
+ "name": "limit",
+ "schema": {
+ "default": 50,
"type": "integer"
}
+ },
+ {
+ "description": "This is an optional parameter. 0-indexed offset. Default is 0.",
+ "in": "query",
+ "name": "offset",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.",
+ "in": "query",
+ "name": "pagePath",
+ "schema": {
+ "type": "string"
+ }
}
],
"responses": {
@@ -21957,9 +21965,1287 @@
"schema": {
"properties": {
"items": {
- "description": "An array of Items for path resource.",
+ "description": "An array of Items for date resource.",
+ "items": {
+ "$ref": "#/components/schemas/statisticsdate"
+ },
+ "type": "array"
+ },
+ "totalResults": {
+ "description": "The total number of paths.",
+ "type": "integer"
+ },
+ "totals": {
+ "properties": {
+ "sessions": {
+ "description": "The sum total of the sessions in the specified period.",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "400": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Bad request"
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Invalid login"
+ },
+ "404": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Not Found"
+ }
+ },
+ "summary": "Retrieve sessions count for each date from provider (e.g. Google Analytics V4)",
+ "tags": [
+ "Statistics"
+ ]
+ }
+ },
+ "/sites/{site_id}/stats/path/pageviews": {
+ "get": {
+ "description": "Retrieve screenPageViews count for each path from provider (e.g. Google Analytics V4).\n\nAuthorization is required.\n",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "site_id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "startDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "endDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. Maximum number of paths to retrieve. Default is 50.",
+ "in": "query",
+ "name": "limit",
+ "schema": {
+ "default": 50,
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is an optional parameter. 0-indexed offset. Default is 0.",
+ "in": "query",
+ "name": "offset",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.",
+ "in": "query",
+ "name": "pagePath",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. If true is given, the MT can return total scrrenPageViews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another screenPageViews by same path.)",
+ "in": "query",
+ "name": "uniquePath",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "description": "An array of Items for path resource.",
+ "items": {
+ "$ref": "#/components/schemas/statisticspath"
+ },
+ "type": "array"
+ },
+ "totalResults": {
+ "description": "The total number of paths.",
+ "type": "integer"
+ },
+ "totals": {
+ "properties": {
+ "screenPageViews": {
+ "description": "The sum total of the screenPageViews in the specified period.",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "400": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Bad request"
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Invalid login"
+ },
+ "404": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Not Found"
+ }
+ },
+ "summary": "Retrieve screenPageViews count for each path from provider (e.g. Google Analytics V4)",
+ "tags": [
+ "Statistics"
+ ]
+ }
+ },
+ "/sites/{site_id}/stats/path/screenPageViews": {
+ "get": {
+ "description": "Retrieve screenPageViews count for each path from provider (e.g. Google Analytics V4).\n\nAuthorization is required.\n",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "site_id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "startDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "endDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. Maximum number of paths to retrieve. Default is 50.",
+ "in": "query",
+ "name": "limit",
+ "schema": {
+ "default": 50,
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is an optional parameter. 0-indexed offset. Default is 0.",
+ "in": "query",
+ "name": "offset",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.",
+ "in": "query",
+ "name": "pagePath",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. If true is given, the MT can return total scrrenPageViews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another screenPageViews by same path.)",
+ "in": "query",
+ "name": "uniquePath",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "description": "An array of Items for path resource.",
+ "items": {
+ "$ref": "#/components/schemas/statisticspath"
+ },
+ "type": "array"
+ },
+ "totalResults": {
+ "description": "The total number of paths.",
+ "type": "integer"
+ },
+ "totals": {
+ "properties": {
+ "screenPageViews": {
+ "description": "The sum total of the screenPageViews in the specified period.",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "400": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Bad request"
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Invalid login"
+ },
+ "404": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Not Found"
+ }
+ },
+ "summary": "Retrieve screenPageViews count for each path from provider (e.g. Google Analytics V4)",
+ "tags": [
+ "Statistics"
+ ]
+ }
+ },
+ "/sites/{site_id}/stats/path/sessions": {
+ "get": {
+ "description": "Retrieve sessions count for each date from provider (e.g. Google Analytics V4).\n\nAuthorization is required.\n",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "site_id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "startDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "endDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. Maximum number of paths to retrieve. Default is 50.",
+ "in": "query",
+ "name": "limit",
+ "schema": {
+ "limit": 50,
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is an optional parameter. 0-indexed offset. Default is 0.",
+ "in": "query",
+ "name": "offset",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.",
+ "in": "query",
+ "name": "pagePath",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "description": "An array of Items for path resource.",
+ "items": {
+ "$ref": "#/components/schemas/statisticspath"
+ },
+ "type": "array"
+ },
+ "totalResults": {
+ "description": "The total number of paths.",
+ "type": "integer"
+ },
+ "totals": {
+ "properties": {
+ "sessions": {
+ "description": "The sum total of the sessions in the specified period.",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "400": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Bad request"
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Invalid login"
+ },
+ "404": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Not Found"
+ }
+ },
+ "summary": "Retrieve sessions count for each path from provider (e.g. Google Analytics V4)",
+ "tags": [
+ "Statistics"
+ ]
+ }
+ },
+ "/sites/{site_id}/stats/path/visits": {
+ "get": {
+ "description": "Retrieve sessions count for each date from provider (e.g. Google Analytics V4).\n\nAuthorization is required.\n",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "site_id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "startDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "endDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. Maximum number of paths to retrieve. Default is 50.",
+ "in": "query",
+ "name": "limit",
+ "schema": {
+ "limit": 50,
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is an optional parameter. 0-indexed offset. Default is 0.",
+ "in": "query",
+ "name": "offset",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.",
+ "in": "query",
+ "name": "pagePath",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "description": "An array of Items for path resource.",
+ "items": {
+ "$ref": "#/components/schemas/statisticspath"
+ },
+ "type": "array"
+ },
+ "totalResults": {
+ "description": "The total number of paths.",
+ "type": "integer"
+ },
+ "totals": {
+ "properties": {
+ "sessions": {
+ "description": "The sum total of the sessions in the specified period.",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "400": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Bad request"
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Invalid login"
+ },
+ "404": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Not Found"
+ }
+ },
+ "summary": "Retrieve sessions count for each path from provider (e.g. Google Analytics V4)",
+ "tags": [
+ "Statistics"
+ ]
+ }
+ },
+ "/sites/{site_id}/stats/provider": {
+ "get": {
+ "description": "Retrieve a current effective provider.\n\nAuthorization is required.\n",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "site_id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "id": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "400": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Bad request"
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Invalid login"
+ },
+ "404": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Not Found"
+ }
+ },
+ "summary": "Retrieve a current effective provider",
+ "tags": [
+ "Statistics"
+ ]
+ }
+ },
+ "/sites/{site_id}/stats/year/screenPageViews": {
+ "get": {
+ "description": "Retrieve screenPageViews count for each year from provider (e.g. Google Analytics V4).\n\nAuthorization is required.\n",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "site_id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "startDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "endDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. Maximum number of paths to retrieve. Default is 50.",
+ "in": "query",
+ "name": "limit",
+ "schema": {
+ "default": 50,
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is an optional parameter. 0-indexed offset. Default is 0.",
+ "in": "query",
+ "name": "offset",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.",
+ "in": "query",
+ "name": "pagePath",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. If true is given, the MT can return total screenPageViews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another screenPageViews by same path.)",
+ "in": "query",
+ "name": "uniquePath",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "description": "An array of Items for date resource.",
+ "items": {
+ "$ref": "#/components/schemas/statisticsyear"
+ },
+ "type": "array"
+ },
+ "totalResults": {
+ "description": "The total number of paths.",
+ "type": "integer"
+ },
+ "totals": {
+ "properties": {
+ "screenPageViews": {
+ "description": "The sum total of the screenPageViews in the specified period.",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "400": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Bad request"
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Invalid login"
+ },
+ "404": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Not Found"
+ }
+ },
+ "summary": "Retrieve screenPageViews count for each year from provider (e.g. Google Analytics V4)",
+ "tags": [
+ "Statistics"
+ ]
+ }
+ },
+ "/sites/{site_id}/stats/year/sessions": {
+ "get": {
+ "description": "Retrieve sessions count for each year from provider (e.g. Google Analytics V4).\n\nAuthorization is required.\n",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "site_id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "startDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "endDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. Maximum number of paths to retrieve. Default is 50.",
+ "in": "query",
+ "name": "limit",
+ "schema": {
+ "default": 50,
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is an optional parameter. 0-indexed offset. Default is 0.",
+ "in": "query",
+ "name": "offset",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.",
+ "in": "query",
+ "name": "pagePath",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "description": "An array of Items for date resource.",
+ "items": {
+ "$ref": "#/components/schemas/statisticsyear"
+ },
+ "type": "array"
+ },
+ "totalResults": {
+ "description": "The total number of paths.",
+ "type": "integer"
+ },
+ "totals": {
+ "properties": {
+ "sessions": {
+ "description": "The sum total of the sessions in the specified period.",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "400": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Bad request"
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Invalid login"
+ },
+ "404": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Not Found"
+ }
+ },
+ "summary": "Retrieve sessions count for each year from provider (e.g. Google Analytics V4)",
+ "tags": [
+ "Statistics"
+ ]
+ }
+ },
+ "/sites/{site_id}/stats/yearMonth/screenPageViews": {
+ "get": {
+ "description": "Retrieve screenPageViews count for each yearMonth from provider (e.g. Google Analytics V4).\n\nAuthorization is required.\n",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "site_id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "startDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "endDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. Maximum number of paths to retrieve. Default is 50.",
+ "in": "query",
+ "name": "limit",
+ "schema": {
+ "default": 50,
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is an optional parameter. 0-indexed offset. Default is 0.",
+ "in": "query",
+ "name": "offset",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.",
+ "in": "query",
+ "name": "pagePath",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. If true is given, the MT can return total screenPageViews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another screenPageViews by same path.)",
+ "in": "query",
+ "name": "uniquePath",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "description": "An array of Items for date resource.",
+ "items": {
+ "$ref": "#/components/schemas/statisticsyearmonth"
+ },
+ "type": "array"
+ },
+ "totalResults": {
+ "description": "The total number of paths.",
+ "type": "integer"
+ },
+ "totals": {
+ "properties": {
+ "screenPageViews": {
+ "description": "The sum total of the screenPageViews in the specified period.",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "400": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Bad request"
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Invalid login"
+ },
+ "404": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Not Found"
+ }
+ },
+ "summary": "Retrieve screenPageViews count for each yearMonth from provider (e.g. Google Analytics V4)",
+ "tags": [
+ "Statistics"
+ ]
+ }
+ },
+ "/sites/{site_id}/stats/yearMonth/sessions": {
+ "get": {
+ "description": "Retrieve sessions count for each yearMonth from provider (e.g. Google Analytics V4).\n\nAuthorization is required.\n",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "site_id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "startDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "endDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. Maximum number of paths to retrieve. Default is 50.",
+ "in": "query",
+ "name": "limit",
+ "schema": {
+ "default": 50,
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is an optional parameter. 0-indexed offset. Default is 0.",
+ "in": "query",
+ "name": "offset",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.",
+ "in": "query",
+ "name": "pagePath",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "description": "An array of Items for date resource.",
+ "items": {
+ "$ref": "#/components/schemas/statisticsyearmonth"
+ },
+ "type": "array"
+ },
+ "totalResults": {
+ "description": "The total number of paths.",
+ "type": "integer"
+ },
+ "totals": {
+ "properties": {
+ "sessions": {
+ "description": "The sum total of the sessions in the specified period.",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "400": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Bad request"
+ },
+ "401": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Invalid login"
+ },
+ "404": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ErrorContent"
+ }
+ }
+ },
+ "description": "Not Found"
+ }
+ },
+ "summary": "Retrieve sessions count for each yearMonth from provider (e.g. Google Analytics V4)",
+ "tags": [
+ "Statistics"
+ ]
+ }
+ },
+ "/sites/{site_id}/stats/yearWeek/screenPageViews": {
+ "get": {
+ "description": "Retrieve screenPageViews count for each yearWeek from provider (e.g. Google Analytics V4).\n\nAuthorization is required.\n",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "site_id",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "startDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "in": "query",
+ "name": "endDate",
+ "required": true,
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. Maximum number of paths to retrieve. Default is 50.",
+ "in": "query",
+ "name": "limit",
+ "schema": {
+ "default": 50,
+ "type": "integer"
+ }
+ },
+ {
+ "description": "This is an optional parameter. 0-indexed offset. Default is 0.",
+ "in": "query",
+ "name": "offset",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.",
+ "in": "query",
+ "name": "pagePath",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "This is an optional parameter. If true is given, the MT can return total screenPageViews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another screenPageViews by same path.)",
+ "in": "query",
+ "name": "uniquePath",
+ "schema": {
+ "enum": [
+ 0,
+ 1
+ ],
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "items": {
+ "description": "An array of Items for date resource.",
"items": {
- "$ref": "#/components/schemas/statisticspath"
+ "$ref": "#/components/schemas/statisticsyearweek"
},
"type": "array"
},
@@ -21970,7 +23256,7 @@
"totals": {
"properties": {
"screenPageViews": {
- "description": "The sum total of the pageviews in the specified period.",
+ "description": "The sum total of the screenPageViews in the specified period.",
"type": "integer"
}
},
@@ -22014,20 +23300,15 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
- "summary": "Retrieve pageviews count for each path from provider (e.g. Google Analytics)",
+ "summary": "Retrieve screenPageViews count for each yearWeek from provider (e.g. Google Analytics V4)",
"tags": [
"Statistics"
]
}
},
- "/sites/{site_id}/stats/path/visits": {
+ "/sites/{site_id}/stats/yearWeek/sessions": {
"get": {
- "description": "Retrieve visits count for each date from provider (e.g. Google Analytics).\n\nAuthorization is required.\n",
+ "description": "Retrieve sessions count for each yearWeek from provider (e.g. Google Analytics V4).\n\nAuthorization is required.\n",
"parameters": [
{
"in": "path",
@@ -22038,7 +23319,7 @@
}
},
{
- "description": "This is an required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. Start date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "startDate",
"required": true,
@@ -22048,7 +23329,7 @@
}
},
{
- "description": "This is an required parameter. End date of data. The format is \"YYYY-MM-DD\".",
+ "description": "This is a required parameter. End date of data. The format is \"YYYY-MM-DD\".",
"in": "query",
"name": "endDate",
"required": true,
@@ -22077,7 +23358,7 @@
{
"description": "This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.",
"in": "query",
- "name": "path",
+ "name": "pagePath",
"schema": {
"type": "string"
}
@@ -22090,9 +23371,9 @@
"schema": {
"properties": {
"items": {
- "description": "An array of Items for path resource.",
+ "description": "An array of Items for date resource.",
"items": {
- "$ref": "#/components/schemas/statisticspath"
+ "$ref": "#/components/schemas/statisticsyearweek"
},
"type": "array"
},
@@ -22147,83 +23428,7 @@
"description": "Not Found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
- "summary": "Retrieve visits count for each path from provider (e.g. Google Analytics)",
- "tags": [
- "Statistics"
- ]
- }
- },
- "/sites/{site_id}/stats/provider": {
- "get": {
- "description": "Retrieve a current effective provider.\n\nAuthorization is required.\n",
- "parameters": [
- {
- "in": "path",
- "name": "site_id",
- "required": true,
- "schema": {
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "id": {
- "type": "string"
- }
- },
- "type": "object"
- }
- }
- },
- "description": "OK"
- },
- "400": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorContent"
- }
- }
- },
- "description": "Bad request"
- },
- "401": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorContent"
- }
- }
- },
- "description": "Invalid login"
- },
- "404": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorContent"
- }
- }
- },
- "description": "Not Found"
- }
- },
- "security": [
- {
- "mtauth": []
- }
- ],
- "summary": "Retrieve a current effective provider",
+ "summary": "Retrieve sessions count for each yearWeek from provider (e.g. Google Analytics V4)",
"tags": [
"Statistics"
]
@@ -22411,11 +23616,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing tag",
"tags": [
"Tags"
@@ -22582,11 +23782,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing tag",
"tags": [
"Tags"
@@ -22626,6 +23821,12 @@
{
"$ref": "#/components/parameters/asset_offset"
},
+ {
+ "$ref": "#/components/parameters/asset_filterKeys"
+ },
+ {
+ "$ref": "#/components/parameters/asset_searchFields"
+ },
{
"description": "The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
"in": "query",
@@ -22794,6 +23995,9 @@
{
"$ref": "#/components/parameters/entry_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/entry_filterKeys"
+ },
{
"$ref": "#/components/parameters/entry_dateField"
},
@@ -22936,6 +24140,9 @@
{
"$ref": "#/components/parameters/page_no_text_filter"
},
+ {
+ "$ref": "#/components/parameters/page_filterKeys"
+ },
{
"$ref": "#/components/parameters/page_dateField"
},
@@ -23035,6 +24242,9 @@
{
"$ref": "#/components/parameters/template_offset"
},
+ {
+ "$ref": "#/components/parameters/template_filterKeys"
+ },
{
"description": "#### id\n\nSort by the ID of each template.\n\n#### name\n\nSort by the name of each template.\n\n#### created_on\n\nSort by the created time of each template.\n\n#### modified_on\n\nSort by the modified time of each template.\n\n#### created_by\n\nSort by the ID of user who created each template.\n\n#### modified_by\n\nSort by the ID of user who modified each template.\n\n#### type\n\nSort by the type of each template.\n\n**Default**: name\n",
"in": "query",
@@ -23141,11 +24351,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of templates in the specified site",
"tags": [
"Templates"
@@ -23161,6 +24366,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/template_saveRevision"
}
],
"requestBody": {
@@ -23222,11 +24430,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new template",
"tags": [
"Templates"
@@ -23326,11 +24529,6 @@
"description": "Site not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a template",
"tags": [
"Templates"
@@ -23413,11 +24611,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a template",
"tags": [
"Templates"
@@ -23491,11 +24684,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve single template by its ID",
"tags": [
"Templates"
@@ -23519,6 +24707,9 @@
"schema": {
"type": "integer"
}
+ },
+ {
+ "$ref": "#/components/parameters/template_saveRevision"
}
],
"requestBody": {
@@ -23590,11 +24781,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a template",
"tags": [
"Templates"
@@ -23672,11 +24858,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a clone of a template",
"tags": [
"Templates"
@@ -23784,11 +24965,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a preview for a template with existing data",
"tags": [
"Templates"
@@ -23866,11 +25042,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Publish a template",
"tags": [
"Templates"
@@ -23954,11 +25125,6 @@
"description": "Site or Template not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset template text to theme default or tempalte_set default",
"tags": [
"Templates"
@@ -24011,6 +25177,9 @@
{
"$ref": "#/components/parameters/templatemap_excludeIds"
},
+ {
+ "$ref": "#/components/parameters/templatemap_filterKeys"
+ },
{
"$ref": "#/components/parameters/templatemap_dateField"
},
@@ -24079,11 +25248,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of templatemaps in the specified site",
"tags": [
"Templates",
@@ -24168,11 +25332,6 @@
"description": "Site or Template not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new templatemap",
"tags": [
"Templates",
@@ -24264,11 +25423,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing templatemap",
"tags": [
"Templates",
@@ -24347,11 +25501,6 @@
"description": "Site or Template or TemplateMap not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single templatemap by its ID",
"tags": [
"Templates",
@@ -24455,11 +25604,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing templatemap",
"tags": [
"Templates",
@@ -24538,11 +25682,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of themes for site",
"tags": [
"Themes"
@@ -24615,11 +25754,6 @@
"description": "Site or Theme not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single theme by its ID for site",
"tags": [
"Themes"
@@ -24697,11 +25831,6 @@
"description": "Site or Theme not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Apply a theme to site",
"tags": [
"Themes"
@@ -24814,11 +25943,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgets in the specified site",
"tags": [
"Widgets"
@@ -24894,11 +26018,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new widget",
"tags": [
"Widgets"
@@ -24981,11 +26100,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete a widget",
"tags": [
"Widgets"
@@ -25058,11 +26172,6 @@
"description": "Site or Widget not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widget by its ID",
"tags": [
"Widgets"
@@ -25157,11 +26266,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update a widget",
"tags": [
"Widgets"
@@ -25238,11 +26342,6 @@
"description": "Site or Widget not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Make a clone of a widget",
"tags": [
"Widgets"
@@ -25325,11 +26424,6 @@
"description": "Site or Widget not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Reset widget text to default",
"tags": [
"Widgets"
@@ -25442,11 +26536,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgetsets in the specified site",
"tags": [
"WidgetSets"
@@ -25522,11 +26611,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new widgetset",
"tags": [
"WidgetSets"
@@ -25609,11 +26693,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete an existing widgetset",
"tags": [
"WidgetSets"
@@ -25686,11 +26765,6 @@
"description": "Site or WidgetSet not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widgetset by its ID",
"tags": [
"WidgetSets"
@@ -25785,11 +26859,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update an existing widgetset",
"tags": [
"WidgetSets"
@@ -25910,11 +26979,6 @@
"description": "Site or WidgetSet not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of widgets in the specified widgetset",
"tags": [
"Widgets",
@@ -25998,11 +27062,6 @@
"description": "Site or Widget not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single widget by widgetset ID",
"tags": [
"Widgets",
@@ -26134,11 +27193,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of themes",
"tags": [
"Themes"
@@ -26213,11 +27267,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Uninstall a specified theme from the MT",
"tags": [
"Themes"
@@ -26280,11 +27329,6 @@
"description": "Site or Theme not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a single theme by its ID",
"tags": [
"Themes"
@@ -26342,11 +27386,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Invalidate current session. This is like logout",
"tags": [
"Authentication"
@@ -26451,6 +27490,9 @@
{
"$ref": "#/components/parameters/user_offset"
},
+ {
+ "$ref": "#/components/parameters/user_filterKeys"
+ },
{
"description": "The field name for sort. You can specify one of following values\n- id\n- name\n\n**Default**: name\n",
"in": "query",
@@ -26635,11 +27677,6 @@
"description": "Site not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Create a new user",
"tags": [
"Users"
@@ -26683,11 +27720,6 @@
"description": "Do not have permission to export users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Export users",
"tags": [
"Users"
@@ -26760,11 +27792,6 @@
"description": "Do not have permission to import users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Import users",
"tags": [
"Users"
@@ -26813,11 +27840,6 @@
"description": "Do not have permission to synchronize users."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Synchronize users",
"tags": [
"Users"
@@ -26892,11 +27914,6 @@
"description": "Request method is not DELETE or POST with __method=DELETE"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Delete user",
"tags": [
"Users"
@@ -27061,11 +28078,6 @@
"description": "Request method is not PUT or POST with __method=PUT"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Update user data",
"tags": [
"Users"
@@ -27104,6 +28116,9 @@
{
"$ref": "#/components/parameters/group_fields"
},
+ {
+ "$ref": "#/components/parameters/group_filterKeys"
+ },
{
"$ref": "#/components/parameters/group_dateField"
},
@@ -27172,11 +28187,6 @@
"description": "User not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of groups",
"tags": [
"Users",
@@ -27214,6 +28224,9 @@
{
"$ref": "#/components/parameters/permission_blogIds"
},
+ {
+ "$ref": "#/components/parameters/permission_filterKeys"
+ },
{
"$ref": "#/components/parameters/permission_dateField"
},
@@ -27282,11 +28295,6 @@
"description": "Site or User not found."
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Retrieve a list of permissions for user",
"tags": [
"Users",
@@ -27376,11 +28384,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Grant permissions to user",
"tags": [
"Users",
@@ -27470,11 +28473,6 @@
"description": "Site or Role or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Revoke permissions from user",
"tags": [
"Users",
@@ -27548,11 +28546,6 @@
"description": "Site or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Send the link for password recovery to specified user by email",
"tags": [
"Users"
@@ -27781,11 +28774,6 @@
"description": "Site or User not found"
}
},
- "security": [
- {
- "mtauth": []
- }
- ],
"summary": "Unlock user account",
"tags": [
"Users"
@@ -27843,6 +28831,11 @@
}
}
},
+ "security": [
+ {
+ "mtauth": []
+ }
+ ],
"servers": [
{
"url": "https://example.com/mt/mt-data-api.cgi/v7"
diff --git a/src/openapi/v7.yaml b/src/openapi/v7.yaml
index 9042ee4..7b38852 100644
--- a/src/openapi/v7.yaml
+++ b/src/openapi/v7.yaml
@@ -32,6 +32,16 @@ components:
name: fields
schema:
type: string
+ asset_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: class
+ in: query
+ name: filterKeys
+ schema:
+ default: class
+ type: string
asset_includeIds:
description: The comma separated ID list of assets to include to result.
in: query
@@ -133,6 +143,12 @@ components:
name: fields
schema:
type: string
+ category_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
category_includeIds:
description: The comma separated ID list of categories to include to result.
in: query
@@ -206,6 +222,12 @@ components:
name: fields
schema:
type: string
+ category_set_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
category_set_includeIds:
description: The comma separated ID list of category_sets to include to result.
in: query
@@ -335,6 +357,16 @@ components:
name: fields
schema:
type: string
+ comment_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
comment_includeIds:
description: The comma separated ID list of comments to include to result.
in: query
@@ -436,6 +468,16 @@ components:
name: fields
schema:
type: string
+ content_data_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
content_data_includeIds:
description: The comma separated ID list of content_data to include to result.
in: query
@@ -462,6 +504,15 @@ components:
schema:
default: 0
type: integer
+ content_data_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
content_data_search:
description: Search query.
in: query
@@ -537,6 +588,12 @@ components:
name: fields
schema:
type: string
+ content_field_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
content_field_includeIds:
description: The comma separated ID list of content_fields to include to result.
in: query
@@ -638,6 +695,12 @@ components:
name: fields
schema:
type: string
+ content_type_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
content_type_includeIds:
description: The comma separated ID list of content_types to include to result.
in: query
@@ -739,6 +802,16 @@ components:
name: fields
schema:
type: string
+ entry_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
entry_includeIds:
description: The comma separated ID list of entries to include to result.
in: query
@@ -786,6 +859,15 @@ components:
schema:
default: 0
type: integer
+ entry_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
entry_search:
description: Search query.
in: query
@@ -912,6 +994,16 @@ components:
name: fields
schema:
type: string
+ field_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: systemObject,type
+ in: query
+ name: filterKeys
+ schema:
+ default: 'systemObject,type'
+ type: string
field_includeIds:
description: The comma separated ID list of fields to include to result.
in: query
@@ -1013,6 +1105,12 @@ components:
name: fields
schema:
type: string
+ folder_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
folder_includeIds:
description: The comma separated ID list of folders to include to result.
in: query
@@ -1114,6 +1212,12 @@ components:
name: fields
schema:
type: string
+ formatted_text_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
formatted_text_includeIds:
description: The comma separated ID list of formatted_texts to include to result.
in: query
@@ -1215,6 +1319,16 @@ components:
name: fields
schema:
type: string
+ group_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
group_includeIds:
description: The comma separated ID list of groups to include to result.
in: query
@@ -1316,6 +1430,16 @@ components:
name: fields
schema:
type: string
+ log_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: level
+ in: query
+ name: filterKeys
+ schema:
+ default: level
+ type: string
log_includeIds:
description: The comma separated ID list of logs to include to result.
in: query
@@ -1417,6 +1541,16 @@ components:
name: fields
schema:
type: string
+ page_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status
+ in: query
+ name: filterKeys
+ schema:
+ default: status
+ type: string
page_includeIds:
description: The comma separated ID list of pages to include to result.
in: query
@@ -1464,6 +1598,15 @@ components:
schema:
default: 0
type: integer
+ page_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
page_search:
description: Search query.
in: query
@@ -1596,6 +1739,16 @@ components:
name: fields
schema:
type: string
+ permission_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: blogIds
+ in: query
+ name: filterKeys
+ schema:
+ default: blogIds
+ type: string
permission_includeIds:
description: The comma separated ID list of permissions to include to result.
in: query
@@ -1709,6 +1862,12 @@ components:
name: fields
schema:
type: string
+ role_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
role_includeIds:
description: The comma separated ID list of roles to include to result.
in: query
@@ -1825,6 +1984,12 @@ components:
name: fields
schema:
type: string
+ site_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
site_includeIds:
description: The comma separated ID list of sites to include to result.
in: query
@@ -1932,6 +2097,12 @@ components:
name: fields
schema:
type: string
+ tag_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
tag_includeIds:
description: The comma separated ID list of tags to include to result.
in: query
@@ -2033,6 +2204,16 @@ components:
name: fields
schema:
type: string
+ template_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: type
+ in: query
+ name: filterKeys
+ schema:
+ default: type
+ type: string
template_includeIds:
description: The comma separated ID list of templates to include to result.
in: query
@@ -2059,6 +2240,15 @@ components:
schema:
default: 0
type: integer
+ template_saveRevision:
+ description: Save a revision or not
+ in: query
+ name: saveRevision
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
template_search:
description: Search query.
in: query
@@ -2134,6 +2324,16 @@ components:
name: fields
schema:
type: string
+ templatemap_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: archiveType,buildType,isPreferred
+ in: query
+ name: filterKeys
+ schema:
+ default: 'archiveType,buildType,isPreferred'
+ type: string
templatemap_includeIds:
description: The comma separated ID list of templatemaps to include to result.
in: query
@@ -2231,6 +2431,16 @@ components:
name: fields
schema:
type: string
+ user_filterKeys:
+ description: |-
+ The comma separated field name list to filter.
+
+ **Default**: status,lockout
+ in: query
+ name: filterKeys
+ schema:
+ default: 'status,lockout'
+ type: string
user_includeIds:
description: The comma separated ID list of users to include to result.
in: query
@@ -2332,6 +2542,12 @@ components:
name: fields
schema:
type: string
+ widget_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
widget_includeIds:
description: The comma separated ID list of widgets to include to result.
in: query
@@ -2433,6 +2649,12 @@ components:
name: fields
schema:
type: string
+ widgetset_filterKeys:
+ description: The comma separated field name list to filter.
+ in: query
+ name: filterKeys
+ schema:
+ type: string
widgetset_includeIds:
description: The comma separated ID list of widgetsets to include to result.
in: query
@@ -4199,10 +4421,10 @@ components:
format: date
type: string
screenPageViews:
- description: The pageviews for the path. This property exists only if the metrics to retrieve is "pageviews"
+ description: The number of screenPageViews for the path. This property exists only if the metrics to retrieve is "screenPageViews"
type: integer
sessions:
- description: The number of sessions for the path. This property exists only if the metrics to retrieve is "visits"
+ description: The number of sessions for the path. This property exists only if the metrics to retrieve is "sessions"
type: integer
type: object
statisticspath:
@@ -4238,11 +4460,47 @@ components:
description: The title for the path.
type: string
screenPageViews:
- description: The pageviews for the path. This property exists only if the metrics to retrieve is "pageviews"
+ description: The pageviews for the path. This property exists only if the metrics to retrieve is "screenPageViews"
+ type: integer
+ sessions:
+ description: The number of sessions for the path. This property exists only if the metrics to retrieve is "sessions"
+ type: integer
+ type: object
+ statisticsyear:
+ properties:
+ screenPageViews:
+ description: The number of screenPageViews for the path. This property exists only if the metrics to retrieve is "screenPageViews"
+ type: integer
+ sessions:
+ description: The number of sessions for the path. This property exists only if the metrics to retrieve is "sessions"
+ type: integer
+ year:
+ description: The year of the target. The format is "YYYY".
+ type: string
+ type: object
+ statisticsyearmonth:
+ properties:
+ screenPageViews:
+ description: The number of screenPageViews for the path. This property exists only if the metrics to retrieve is "screenPageViews"
+ type: integer
+ sessions:
+ description: The number of sessions for the path. This property exists only if the metrics to retrieve is "sessions"
+ type: integer
+ yearMonth:
+ description: The year and month of the target. The format is "YYYY-MM".
+ type: string
+ type: object
+ statisticsyearweek:
+ properties:
+ screenPageViews:
+ description: The number of screenPageViews for the path. This property exists only if the metrics to retrieve is "screenPageViews"
type: integer
sessions:
- description: The number of sessions for the path. This property exists only if the metrics to retrieve is "visits"
+ description: The number of sessions for the path. This property exists only if the metrics to retrieve is "sessions"
type: integer
+ yearWeek:
+ description: The year and week of the target. The format is "YYYY-Www".
+ type: string
type: object
tag:
description: Updatable fields are name
@@ -4891,7 +5149,7 @@ externalDocs:
url: https://www.movabletype.jp/developers/data-api/
info:
title: Movable Type Data API
- version: 8.6.0
+ version: 8.7.0
openapi: 3.0.0
paths:
/:
@@ -5023,8 +5281,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Upload file size is larger than CGIMaxUpload.
- security:
- - mtauth: []
summary: Upload a file
tags:
- Assets
@@ -5246,6 +5502,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/group_dateField'
- $ref: '#/components/parameters/group_dateFrom'
- $ref: '#/components/parameters/group_dateTo'
@@ -5279,8 +5536,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to retrieve the requested groups.
- security:
- - mtauth: []
summary: Retrieve a list of groups
tags:
- Groups
@@ -5314,8 +5569,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to create a group.
- security:
- - mtauth: []
summary: Create a new group
tags:
- Groups
@@ -5345,8 +5598,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to synchronize groups.
- security:
- - mtauth: []
summary: Synchronize groups
tags:
- Groups
@@ -5395,8 +5646,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a group
tags:
- Groups
@@ -5435,8 +5684,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve single group by its ID
tags:
- Groups
@@ -5492,8 +5739,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a group
tags:
- Groups
@@ -5512,6 +5757,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/user_dateField'
- $ref: '#/components/parameters/user_dateFrom'
- $ref: '#/components/parameters/user_dateTo'
@@ -5551,8 +5797,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve a list of members for specified group
tags:
- Groups
@@ -5601,8 +5845,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group or Member not found.
- security:
- - mtauth: []
tags:
- Groups
'/groups/{group_id}/members/{member_id}':
@@ -5655,8 +5897,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
tags:
- Groups
get:
@@ -5699,8 +5939,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group or Member not found.
- security:
- - mtauth: []
summary: Retrieve single member by its ID for specified group
tags:
- Groups
@@ -5721,6 +5959,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -5760,8 +5999,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Group not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for group
tags:
- Groups
@@ -5819,8 +6056,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Group not found
- security:
- - mtauth: []
summary: Grant permissions to group
tags:
- Groups
@@ -5878,8 +6113,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Group not found
- security:
- - mtauth: []
summary: Revoke permissions from group
tags:
- Groups
@@ -5896,6 +6129,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -5935,8 +6169,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions
tags:
- Permissions
@@ -5978,8 +6210,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of plugins in the specified site
tags:
- Plugins
@@ -6015,8 +6245,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Disable all plugins
tags:
- Plugins
@@ -6052,8 +6280,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Enable all plugins
tags:
- Plugins
@@ -6092,8 +6318,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found.
- security:
- - mtauth: []
summary: Retrieve single plugin by its ID
tags:
- Plugins
@@ -6135,8 +6359,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Disable a plugin
tags:
- Plugins
@@ -6178,8 +6400,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Plugin not found
- security:
- - mtauth: []
summary: Enable a plugin
tags:
- Plugins
@@ -6242,8 +6462,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to publish content_data.
- security:
- - mtauth: []
summary: Publish Content Data
tags:
- Content Data
@@ -6321,8 +6539,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to publish.
- security:
- - mtauth: []
summary: Rebuild the static archives in relation to specified entries
tags:
- Entries
@@ -6424,8 +6640,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to retrieve the list of roles.
- security:
- - mtauth: []
summary: Retrieve a list of roles
tags:
- Roles
@@ -6465,8 +6679,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new role
tags:
- Roles
@@ -6515,8 +6727,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing role
tags:
- Roles
@@ -6555,8 +6765,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role not found.
- security:
- - mtauth: []
summary: Retrieve a single role by its ID
tags:
- Roles
@@ -6612,8 +6820,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing role
tags:
- Roles
@@ -6637,6 +6843,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -6676,8 +6883,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions by role
tags:
- Roles
@@ -6925,8 +7130,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new website
tags:
- Sites
@@ -6981,8 +7184,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing blog or website
tags:
- Sites
@@ -7081,8 +7282,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new blog
tags:
- Sites
@@ -7143,8 +7342,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing blog or website
tags:
- Sites
@@ -7165,6 +7362,7 @@ paths:
- $ref: '#/components/parameters/asset_searchFields'
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -7336,8 +7534,6 @@ paths:
type: object
type: object
description: Conflict
- security:
- - mtauth: []
summary: Upload a file
tags:
- Assets
@@ -7396,8 +7592,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an asset
tags:
- Assets
@@ -7511,8 +7705,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an asset
tags:
- Assets
@@ -7554,6 +7746,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -7635,6 +7828,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -7794,8 +7988,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Backup specified site
tags:
- Sites
@@ -7953,8 +8145,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new category
tags:
- Categories
@@ -8016,8 +8206,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Rearrange existing categories in a new order
tags:
- Categories
@@ -8077,8 +8265,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing category
tags:
- Categories
@@ -8192,8 +8378,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing category
tags:
- Categories
@@ -8316,6 +8500,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -8688,8 +8873,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new category set
tags:
- Category Sets
@@ -8746,8 +8929,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete category set
tags:
- Category Sets
@@ -8865,8 +9046,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update category set
tags:
- Category Sets
@@ -8905,6 +9084,11 @@ paths:
- 0
- 1
type: integer
+ - $ref: '#/components/parameters/category_limit'
+ - $ref: '#/components/parameters/category_offset'
+ - $ref: '#/components/parameters/category_searchFields'
+ - $ref: '#/components/parameters/category_sortBy'
+ - $ref: '#/components/parameters/category_sortOrder'
- $ref: '#/components/parameters/category_dateField'
- $ref: '#/components/parameters/category_dateFrom'
- $ref: '#/components/parameters/category_dateTo'
@@ -9003,8 +9187,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site pr Category_set not found.
- security:
- - mtauth: []
summary: Create a new category for category set
tags:
- Categories
@@ -9078,8 +9260,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Category_set not found.
- security:
- - mtauth: []
summary: Save hierarchical categories order in category set
tags:
- Categories
@@ -9144,8 +9324,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete single category in category set
tags:
- Categories
@@ -9276,8 +9454,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update single category in category set
tags:
- Categories
@@ -9676,6 +9852,10 @@ paths:
- Future
- Spam
type: string
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -9771,8 +9951,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a comment
tags:
- Comments
@@ -9887,8 +10065,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a comment
tags:
- Comments
@@ -9908,6 +10084,7 @@ paths:
type: integer
- $ref: '#/components/parameters/content_type_limit'
- $ref: '#/components/parameters/content_type_offset'
+ - $ref: '#/components/parameters/content_type_searchFields'
- description: |
The field name for sort. You can specify one of following values.
- name
@@ -9964,8 +10141,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Content Type Collection
tags:
- Content Types
@@ -10021,8 +10196,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create Content Type
tags:
- Content Types
@@ -10081,8 +10254,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete Content Type
tags:
- Content Types
@@ -10132,8 +10303,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Fetch single Content Type
tags:
- Content Types
@@ -10199,8 +10368,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update Content Type
tags:
- Content Types
@@ -10232,6 +10399,8 @@ paths:
type: string
- $ref: '#/components/parameters/content_data_limit'
- $ref: '#/components/parameters/content_data_offset'
+ - $ref: '#/components/parameters/content_data_filterKeys'
+ - $ref: '#/components/parameters/content_data_searchFields'
- description: |
The field name for sort. You can specify one of following values.
- id
@@ -10323,6 +10492,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/content_data_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -10358,8 +10528,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Create Content Data
tags:
- Content Types
@@ -10443,8 +10611,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found
- security:
- - mtauth: []
summary: Make a preview by data
tags:
- Content Types
@@ -10511,8 +10677,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete single content data
tags:
- Content Types
@@ -10609,6 +10773,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/content_data_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -10650,8 +10815,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update Content Data
tags:
- Content Types
@@ -10740,8 +10903,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type or Content_data not found
- security:
- - mtauth: []
summary: Make a preview by id
tags:
- Content Types
@@ -10767,6 +10928,7 @@ paths:
type: integer
- $ref: '#/components/parameters/content_field_limit'
- $ref: '#/components/parameters/content_field_offset'
+ - $ref: '#/components/parameters/content_field_searchFields'
- description: |
The field name for sort. You can specify one of following values.
- name
@@ -10823,8 +10985,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Content Field Collection
tags:
- Content Fields
@@ -10886,8 +11046,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Create Content Field
tags:
- Content Types
@@ -10960,8 +11118,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type not found.
- security:
- - mtauth: []
summary: Save hierarchical content field order
tags:
- Content Types
@@ -11026,8 +11182,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete Content Field
tags:
- Content Types
@@ -11083,8 +11237,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Content_type or Content_field not found.
- security:
- - mtauth: []
summary: Fetch single Content Field
tags:
- Content Types
@@ -11158,8 +11310,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update Content Field
tags:
- Content Types
@@ -11194,6 +11344,7 @@ paths:
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_fields'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -11253,6 +11404,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/entry_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -11294,8 +11446,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new entry
tags:
- Entries
@@ -11334,8 +11484,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Export entries
tags:
- Entries
@@ -11418,8 +11566,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Import entries
tags:
- Entries
@@ -11487,8 +11633,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Entry not found
- security:
- - mtauth: []
summary: Make a preview for a entry
tags:
- Entries
@@ -11546,8 +11690,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an entry
tags:
- Entries
@@ -11643,6 +11785,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/entry_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -11690,8 +11833,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an entry
tags:
- Entries
@@ -11745,6 +11886,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_sortOrder'
- $ref: '#/components/parameters/asset_fields'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- $ref: '#/components/parameters/asset_dateField'
- $ref: '#/components/parameters/asset_dateFrom'
- $ref: '#/components/parameters/asset_dateTo'
@@ -11950,6 +12093,10 @@ paths:
name: offset
schema:
type: integer
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -12044,8 +12191,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Create a new comment on an entry
tags:
- Comments
@@ -12107,8 +12252,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Reply to specified comment
tags:
- Comments
@@ -12183,8 +12326,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Entry not found
- security:
- - mtauth: []
summary: Make a preview for a entry with existing data
tags:
- Entries
@@ -12288,8 +12429,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found
- security:
- - mtauth: []
summary: Export site's theme
tags:
- Themes
@@ -12308,6 +12447,7 @@ paths:
- $ref: '#/components/parameters/field_sortBy'
- $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/field_fields'
+ - $ref: '#/components/parameters/field_filterKeys'
- $ref: '#/components/parameters/field_dateField'
- $ref: '#/components/parameters/field_dateFrom'
- $ref: '#/components/parameters/field_dateTo'
@@ -12347,8 +12487,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of fields in the specified site
tags:
- CustomFields
@@ -12394,8 +12532,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new field
tags:
- CustomFields
@@ -12449,8 +12585,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a field
tags:
- CustomFields
@@ -12494,8 +12628,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Field not found.
- security:
- - mtauth: []
summary: Retrieve single field by its ID
tags:
- CustomFields
@@ -12556,8 +12688,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a field
tags:
- CustomFields
@@ -12710,8 +12840,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new folder.
tags:
- Folders
@@ -12773,8 +12901,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Rearrange existing folders in a new order
tags:
- Folders
@@ -12834,8 +12960,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing folder
tags:
- Folders
@@ -12949,8 +13073,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing folder
tags:
- Folders
@@ -13068,6 +13190,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -13349,8 +13472,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of formatted_texts in the specified site
tags:
- FormattedText
@@ -13396,8 +13517,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new formatted_text
tags:
- FormattedText
@@ -13451,8 +13570,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a formatted_text
tags:
- FormattedText
@@ -13496,8 +13613,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or FormattedText not found.
- security:
- - mtauth: []
summary: Retrieve single formatted_text by its ID
tags:
- FormattedText
@@ -13558,8 +13673,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a formatted_text
tags:
- FormattedText
@@ -13611,8 +13724,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Reset logs
tags:
- Logs
@@ -13634,6 +13745,7 @@ paths:
- $ref: '#/components/parameters/log_searchFields'
- $ref: '#/components/parameters/log_limit'
- $ref: '#/components/parameters/log_offset'
+ - $ref: '#/components/parameters/log_filterKeys'
- description: |
- id
- created_on
@@ -13724,8 +13836,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of logs in the specified site
tags:
- Logs
@@ -13771,8 +13881,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new log
tags:
- Logs
@@ -13815,8 +13923,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Export logs
tags:
- Logs
@@ -13870,8 +13976,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing log
tags:
- Logs
@@ -13915,8 +14019,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Log not found.
- security:
- - mtauth: []
summary: Retrieve a single log by its ID
tags:
- Logs
@@ -13977,8 +14079,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing log
tags:
- Logs
@@ -14015,6 +14115,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -14074,6 +14175,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/page_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -14115,8 +14217,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new page
tags:
- Pages
@@ -14184,8 +14284,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Page not found
- security:
- - mtauth: []
summary: Make a preview for a page
tags:
- Pages
@@ -14244,8 +14342,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing page
tags:
- Pages
@@ -14323,6 +14419,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/page_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -14370,8 +14467,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing page
tags:
- Pages
@@ -14395,6 +14490,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -14498,6 +14595,10 @@ paths:
name: offset
schema:
type: integer
+ - $ref: '#/components/parameters/field_filterKeys'
+ - $ref: '#/components/parameters/field_searchFields'
+ - $ref: '#/components/parameters/field_sortBy'
+ - $ref: '#/components/parameters/field_sortOrder'
- $ref: '#/components/parameters/comment_dateField'
- $ref: '#/components/parameters/comment_dateFrom'
- $ref: '#/components/parameters/comment_dateTo'
@@ -14592,8 +14693,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Create a new comment on a page
tags:
- Comments
@@ -14655,8 +14754,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
summary: Reply to specified comment
tags:
- Comments
@@ -14731,8 +14828,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Page not found
- security:
- - mtauth: []
summary: Make a preview for a page with existing data
tags:
- Pages
@@ -14796,8 +14891,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for site
tags:
- Sites
@@ -14855,8 +14948,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Grant permissions to site
tags:
- Sites
@@ -14914,8 +15005,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Revoke permissions from site
tags:
- Sites
@@ -14984,15 +15073,13 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Reset all templates in the site
tags:
- Templates
'/sites/{site_id}/stats/date/pageviews':
get:
description: |
- Retrieve pageviews count for each date from provider (e.g. Google Analytics).
+ Retrieve screenPageViews count for each date from provider (e.g. Google Analytics V4).
Authorization is required.
parameters:
@@ -15001,14 +15088,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -15028,10 +15115,10 @@ paths:
type: string
- description: This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.
in: query
- name: path
+ name: pagePath
schema:
type: string
- - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
+ - description: 'This is an optional parameter. If true is given, the MT can return total screenPageViews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another screenPageViews by same path.)'
in: query
name: uniquePath
schema:
@@ -15056,7 +15143,7 @@ paths:
totals:
properties:
screenPageViews:
- description: The sum total of the pageviews in the specified period.
+ description: The sum total of the screenPageViews in the specified period.
type: integer
type: object
type: object
@@ -15079,15 +15166,13 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
- summary: Retrieve pageviews count for each date from provider (e.g. Google Analytics)
+ summary: Retrieve screenPageViews count for each date from provider (e.g. Google Analytics V4)
tags:
- Statistics
- '/sites/{site_id}/stats/date/visits':
+ '/sites/{site_id}/stats/date/screenPageViews':
get:
description: |
- Retrieve visits count for each date from provider (e.g. Google Analytics).
+ Retrieve screenPageViews count for each date from provider (e.g. Google Analytics V4).
Authorization is required.
parameters:
@@ -15096,14 +15181,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -15123,9 +15208,17 @@ paths:
type: string
- description: This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.
in: query
- name: path
+ name: pagePath
schema:
type: string
+ - description: 'This is an optional parameter. If true is given, the MT can return total screenPageViews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another screenPageViews by same path.)'
+ in: query
+ name: uniquePath
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
responses:
200:
content:
@@ -15142,8 +15235,8 @@ paths:
type: integer
totals:
properties:
- sessions:
- description: The sum total of the sessions in the specified period.
+ screenPageViews:
+ description: The sum total of the screenPageViews in the specified period.
type: integer
type: object
type: object
@@ -15166,15 +15259,13 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
- summary: Retrieve visits count for each date from provider (e.g. Google Analytics)
+ summary: Retrieve screenPageViews count for each date from provider (e.g. Google Analytics V4)
tags:
- Statistics
- '/sites/{site_id}/stats/path/pageviews':
+ '/sites/{site_id}/stats/date/sessions':
get:
description: |
- Retrieve pageviews count for each path from provider (e.g. Google Analytics).
+ Retrieve sessions count for each date from provider (e.g. Google Analytics V4).
Authorization is required.
parameters:
@@ -15183,14 +15274,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -15210,17 +15301,9 @@ paths:
type: string
- description: This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.
in: query
- name: path
+ name: pagePath
schema:
type: string
- - description: 'This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)'
- in: query
- name: uniquePath
- schema:
- enum:
- - 0
- - 1
- type: integer
responses:
200:
content:
@@ -15228,17 +15311,17 @@ paths:
schema:
properties:
items:
- description: An array of Items for path resource.
+ description: An array of Items for date resource.
items:
- $ref: '#/components/schemas/statisticspath'
+ $ref: '#/components/schemas/statisticsdate'
type: array
totalResults:
description: The total number of paths.
type: integer
totals:
properties:
- screenPageViews:
- description: The sum total of the pageviews in the specified period.
+ sessions:
+ description: The sum total of the sessions in the specified period.
type: integer
type: object
type: object
@@ -15261,15 +15344,13 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
- summary: Retrieve pageviews count for each path from provider (e.g. Google Analytics)
+ summary: Retrieve sessions count for each date from provider (e.g. Google Analytics V4)
tags:
- Statistics
- '/sites/{site_id}/stats/path/visits':
+ '/sites/{site_id}/stats/date/visits':
get:
description: |
- Retrieve visits count for each date from provider (e.g. Google Analytics).
+ Retrieve sessions count for each date from provider (e.g. Google Analytics V4).
Authorization is required.
parameters:
@@ -15278,14 +15359,14 @@ paths:
required: 1
schema:
type: integer
- - description: This is an required parameter. Start date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
in: query
name: startDate
required: 1
schema:
format: date
type: string
- - description: This is an required parameter. End date of data. The format is "YYYY-MM-DD".
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
in: query
name: endDate
required: 1
@@ -15305,7 +15386,7 @@ paths:
type: string
- description: This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.
in: query
- name: path
+ name: pagePath
schema:
type: string
responses:
@@ -15315,9 +15396,9 @@ paths:
schema:
properties:
items:
- description: An array of Items for path resource.
+ description: An array of Items for date resource.
items:
- $ref: '#/components/schemas/statisticspath'
+ $ref: '#/components/schemas/statisticsdate'
type: array
totalResults:
description: The total number of paths.
@@ -15348,15 +15429,13 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
- summary: Retrieve visits count for each path from provider (e.g. Google Analytics)
+ summary: Retrieve sessions count for each date from provider (e.g. Google Analytics V4)
tags:
- Statistics
- '/sites/{site_id}/stats/provider':
+ '/sites/{site_id}/stats/path/pageviews':
get:
description: |
- Retrieve a current effective provider.
+ Retrieve screenPageViews count for each path from provider (e.g. Google Analytics V4).
Authorization is required.
parameters:
@@ -15365,14 +15444,64 @@ paths:
required: 1
schema:
type: integer
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: startDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: endDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is an optional parameter. Maximum number of paths to retrieve. Default is 50.
+ in: query
+ name: limit
+ schema:
+ default: 50
+ type: integer
+ - description: This is an optional parameter. 0-indexed offset. Default is 0.
+ in: query
+ name: offset
+ schema:
+ type: string
+ - description: This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.
+ in: query
+ name: pagePath
+ schema:
+ type: string
+ - description: 'This is an optional parameter. If true is given, the MT can return total scrrenPageViews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another screenPageViews by same path.)'
+ in: query
+ name: uniquePath
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
responses:
200:
content:
application/json:
schema:
properties:
- id:
- type: string
+ items:
+ description: An array of Items for path resource.
+ items:
+ $ref: '#/components/schemas/statisticspath'
+ type: array
+ totalResults:
+ description: The total number of paths.
+ type: integer
+ totals:
+ properties:
+ screenPageViews:
+ description: The sum total of the screenPageViews in the specified period.
+ type: integer
+ type: object
type: object
description: OK
400:
@@ -15393,33 +15522,871 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Not Found
- security:
- - mtauth: []
- summary: Retrieve a current effective provider
+ summary: Retrieve screenPageViews count for each path from provider (e.g. Google Analytics V4)
tags:
- Statistics
- '/sites/{site_id}/tags':
+ '/sites/{site_id}/stats/path/screenPageViews':
get:
+ description: |
+ Retrieve screenPageViews count for each path from provider (e.g. Google Analytics V4).
+
+ Authorization is required.
parameters:
- in: path
name: site_id
required: 1
schema:
type: integer
- - $ref: '#/components/parameters/tag_search'
- - $ref: '#/components/parameters/tag_searchFields'
- - $ref: '#/components/parameters/tag_limit'
- - $ref: '#/components/parameters/tag_offset'
- - $ref: '#/components/parameters/tag_sortBy'
- - $ref: '#/components/parameters/tag_sortOrder'
- - $ref: '#/components/parameters/tag_fields'
- - $ref: '#/components/parameters/tag_dateField'
- - $ref: '#/components/parameters/tag_dateFrom'
- - $ref: '#/components/parameters/tag_dateTo'
- responses:
- 200:
- content:
- application/json:
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: startDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: endDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is an optional parameter. Maximum number of paths to retrieve. Default is 50.
+ in: query
+ name: limit
+ schema:
+ default: 50
+ type: integer
+ - description: This is an optional parameter. 0-indexed offset. Default is 0.
+ in: query
+ name: offset
+ schema:
+ type: string
+ - description: This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.
+ in: query
+ name: pagePath
+ schema:
+ type: string
+ - description: 'This is an optional parameter. If true is given, the MT can return total scrrenPageViews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another screenPageViews by same path.)'
+ in: query
+ name: uniquePath
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
+ responses:
+ 200:
+ content:
+ application/json:
+ schema:
+ properties:
+ items:
+ description: An array of Items for path resource.
+ items:
+ $ref: '#/components/schemas/statisticspath'
+ type: array
+ totalResults:
+ description: The total number of paths.
+ type: integer
+ totals:
+ properties:
+ screenPageViews:
+ description: The sum total of the screenPageViews in the specified period.
+ type: integer
+ type: object
+ type: object
+ description: OK
+ 400:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Bad request
+ 401:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Invalid login
+ 404:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Not Found
+ summary: Retrieve screenPageViews count for each path from provider (e.g. Google Analytics V4)
+ tags:
+ - Statistics
+ '/sites/{site_id}/stats/path/sessions':
+ get:
+ description: |
+ Retrieve sessions count for each date from provider (e.g. Google Analytics V4).
+
+ Authorization is required.
+ parameters:
+ - in: path
+ name: site_id
+ required: 1
+ schema:
+ type: integer
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: startDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: endDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is an optional parameter. Maximum number of paths to retrieve. Default is 50.
+ in: query
+ name: limit
+ schema:
+ limit: 50
+ type: integer
+ - description: This is an optional parameter. 0-indexed offset. Default is 0.
+ in: query
+ name: offset
+ schema:
+ type: string
+ - description: This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.
+ in: query
+ name: pagePath
+ schema:
+ type: string
+ responses:
+ 200:
+ content:
+ application/json:
+ schema:
+ properties:
+ items:
+ description: An array of Items for path resource.
+ items:
+ $ref: '#/components/schemas/statisticspath'
+ type: array
+ totalResults:
+ description: The total number of paths.
+ type: integer
+ totals:
+ properties:
+ sessions:
+ description: The sum total of the sessions in the specified period.
+ type: integer
+ type: object
+ type: object
+ description: OK
+ 400:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Bad request
+ 401:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Invalid login
+ 404:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Not Found
+ summary: Retrieve sessions count for each path from provider (e.g. Google Analytics V4)
+ tags:
+ - Statistics
+ '/sites/{site_id}/stats/path/visits':
+ get:
+ description: |
+ Retrieve sessions count for each date from provider (e.g. Google Analytics V4).
+
+ Authorization is required.
+ parameters:
+ - in: path
+ name: site_id
+ required: 1
+ schema:
+ type: integer
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: startDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: endDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is an optional parameter. Maximum number of paths to retrieve. Default is 50.
+ in: query
+ name: limit
+ schema:
+ limit: 50
+ type: integer
+ - description: This is an optional parameter. 0-indexed offset. Default is 0.
+ in: query
+ name: offset
+ schema:
+ type: string
+ - description: This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.
+ in: query
+ name: pagePath
+ schema:
+ type: string
+ responses:
+ 200:
+ content:
+ application/json:
+ schema:
+ properties:
+ items:
+ description: An array of Items for path resource.
+ items:
+ $ref: '#/components/schemas/statisticspath'
+ type: array
+ totalResults:
+ description: The total number of paths.
+ type: integer
+ totals:
+ properties:
+ sessions:
+ description: The sum total of the sessions in the specified period.
+ type: integer
+ type: object
+ type: object
+ description: OK
+ 400:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Bad request
+ 401:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Invalid login
+ 404:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Not Found
+ summary: Retrieve sessions count for each path from provider (e.g. Google Analytics V4)
+ tags:
+ - Statistics
+ '/sites/{site_id}/stats/provider':
+ get:
+ description: |
+ Retrieve a current effective provider.
+
+ Authorization is required.
+ parameters:
+ - in: path
+ name: site_id
+ required: 1
+ schema:
+ type: integer
+ responses:
+ 200:
+ content:
+ application/json:
+ schema:
+ properties:
+ id:
+ type: string
+ type: object
+ description: OK
+ 400:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Bad request
+ 401:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Invalid login
+ 404:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Not Found
+ summary: Retrieve a current effective provider
+ tags:
+ - Statistics
+ '/sites/{site_id}/stats/year/screenPageViews':
+ get:
+ description: |
+ Retrieve screenPageViews count for each year from provider (e.g. Google Analytics V4).
+
+ Authorization is required.
+ parameters:
+ - in: path
+ name: site_id
+ required: 1
+ schema:
+ type: integer
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: startDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: endDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is an optional parameter. Maximum number of paths to retrieve. Default is 50.
+ in: query
+ name: limit
+ schema:
+ default: 50
+ type: integer
+ - description: This is an optional parameter. 0-indexed offset. Default is 0.
+ in: query
+ name: offset
+ schema:
+ type: string
+ - description: This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.
+ in: query
+ name: pagePath
+ schema:
+ type: string
+ - description: 'This is an optional parameter. If true is given, the MT can return total screenPageViews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another screenPageViews by same path.)'
+ in: query
+ name: uniquePath
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
+ responses:
+ 200:
+ content:
+ application/json:
+ schema:
+ properties:
+ items:
+ description: An array of Items for date resource.
+ items:
+ $ref: '#/components/schemas/statisticsyear'
+ type: array
+ totalResults:
+ description: The total number of paths.
+ type: integer
+ totals:
+ properties:
+ screenPageViews:
+ description: The sum total of the screenPageViews in the specified period.
+ type: integer
+ type: object
+ type: object
+ description: OK
+ 400:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Bad request
+ 401:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Invalid login
+ 404:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Not Found
+ summary: Retrieve screenPageViews count for each year from provider (e.g. Google Analytics V4)
+ tags:
+ - Statistics
+ '/sites/{site_id}/stats/year/sessions':
+ get:
+ description: |
+ Retrieve sessions count for each year from provider (e.g. Google Analytics V4).
+
+ Authorization is required.
+ parameters:
+ - in: path
+ name: site_id
+ required: 1
+ schema:
+ type: integer
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: startDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: endDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is an optional parameter. Maximum number of paths to retrieve. Default is 50.
+ in: query
+ name: limit
+ schema:
+ default: 50
+ type: integer
+ - description: This is an optional parameter. 0-indexed offset. Default is 0.
+ in: query
+ name: offset
+ schema:
+ type: string
+ - description: This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.
+ in: query
+ name: pagePath
+ schema:
+ type: string
+ responses:
+ 200:
+ content:
+ application/json:
+ schema:
+ properties:
+ items:
+ description: An array of Items for date resource.
+ items:
+ $ref: '#/components/schemas/statisticsyear'
+ type: array
+ totalResults:
+ description: The total number of paths.
+ type: integer
+ totals:
+ properties:
+ sessions:
+ description: The sum total of the sessions in the specified period.
+ type: integer
+ type: object
+ type: object
+ description: OK
+ 400:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Bad request
+ 401:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Invalid login
+ 404:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Not Found
+ summary: Retrieve sessions count for each year from provider (e.g. Google Analytics V4)
+ tags:
+ - Statistics
+ '/sites/{site_id}/stats/yearMonth/screenPageViews':
+ get:
+ description: |
+ Retrieve screenPageViews count for each yearMonth from provider (e.g. Google Analytics V4).
+
+ Authorization is required.
+ parameters:
+ - in: path
+ name: site_id
+ required: 1
+ schema:
+ type: integer
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: startDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: endDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is an optional parameter. Maximum number of paths to retrieve. Default is 50.
+ in: query
+ name: limit
+ schema:
+ default: 50
+ type: integer
+ - description: This is an optional parameter. 0-indexed offset. Default is 0.
+ in: query
+ name: offset
+ schema:
+ type: string
+ - description: This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.
+ in: query
+ name: pagePath
+ schema:
+ type: string
+ - description: 'This is an optional parameter. If true is given, the MT can return total screenPageViews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another screenPageViews by same path.)'
+ in: query
+ name: uniquePath
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
+ responses:
+ 200:
+ content:
+ application/json:
+ schema:
+ properties:
+ items:
+ description: An array of Items for date resource.
+ items:
+ $ref: '#/components/schemas/statisticsyearmonth'
+ type: array
+ totalResults:
+ description: The total number of paths.
+ type: integer
+ totals:
+ properties:
+ screenPageViews:
+ description: The sum total of the screenPageViews in the specified period.
+ type: integer
+ type: object
+ type: object
+ description: OK
+ 400:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Bad request
+ 401:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Invalid login
+ 404:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Not Found
+ summary: Retrieve screenPageViews count for each yearMonth from provider (e.g. Google Analytics V4)
+ tags:
+ - Statistics
+ '/sites/{site_id}/stats/yearMonth/sessions':
+ get:
+ description: |
+ Retrieve sessions count for each yearMonth from provider (e.g. Google Analytics V4).
+
+ Authorization is required.
+ parameters:
+ - in: path
+ name: site_id
+ required: 1
+ schema:
+ type: integer
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: startDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: endDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is an optional parameter. Maximum number of paths to retrieve. Default is 50.
+ in: query
+ name: limit
+ schema:
+ default: 50
+ type: integer
+ - description: This is an optional parameter. 0-indexed offset. Default is 0.
+ in: query
+ name: offset
+ schema:
+ type: string
+ - description: This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.
+ in: query
+ name: pagePath
+ schema:
+ type: string
+ responses:
+ 200:
+ content:
+ application/json:
+ schema:
+ properties:
+ items:
+ description: An array of Items for date resource.
+ items:
+ $ref: '#/components/schemas/statisticsyearmonth'
+ type: array
+ totalResults:
+ description: The total number of paths.
+ type: integer
+ totals:
+ properties:
+ sessions:
+ description: The sum total of the sessions in the specified period.
+ type: integer
+ type: object
+ type: object
+ description: OK
+ 400:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Bad request
+ 401:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Invalid login
+ 404:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Not Found
+ summary: Retrieve sessions count for each yearMonth from provider (e.g. Google Analytics V4)
+ tags:
+ - Statistics
+ '/sites/{site_id}/stats/yearWeek/screenPageViews':
+ get:
+ description: |
+ Retrieve screenPageViews count for each yearWeek from provider (e.g. Google Analytics V4).
+
+ Authorization is required.
+ parameters:
+ - in: path
+ name: site_id
+ required: 1
+ schema:
+ type: integer
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: startDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: endDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is an optional parameter. Maximum number of paths to retrieve. Default is 50.
+ in: query
+ name: limit
+ schema:
+ default: 50
+ type: integer
+ - description: This is an optional parameter. 0-indexed offset. Default is 0.
+ in: query
+ name: offset
+ schema:
+ type: string
+ - description: This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.
+ in: query
+ name: pagePath
+ schema:
+ type: string
+ - description: 'This is an optional parameter. If true is given, the MT can return total screenPageViews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another screenPageViews by same path.)'
+ in: query
+ name: uniquePath
+ schema:
+ enum:
+ - 0
+ - 1
+ type: integer
+ responses:
+ 200:
+ content:
+ application/json:
+ schema:
+ properties:
+ items:
+ description: An array of Items for date resource.
+ items:
+ $ref: '#/components/schemas/statisticsyearweek'
+ type: array
+ totalResults:
+ description: The total number of paths.
+ type: integer
+ totals:
+ properties:
+ screenPageViews:
+ description: The sum total of the screenPageViews in the specified period.
+ type: integer
+ type: object
+ type: object
+ description: OK
+ 400:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Bad request
+ 401:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Invalid login
+ 404:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Not Found
+ summary: Retrieve screenPageViews count for each yearWeek from provider (e.g. Google Analytics V4)
+ tags:
+ - Statistics
+ '/sites/{site_id}/stats/yearWeek/sessions':
+ get:
+ description: |
+ Retrieve sessions count for each yearWeek from provider (e.g. Google Analytics V4).
+
+ Authorization is required.
+ parameters:
+ - in: path
+ name: site_id
+ required: 1
+ schema:
+ type: integer
+ - description: This is a required parameter. Start date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: startDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is a required parameter. End date of data. The format is "YYYY-MM-DD".
+ in: query
+ name: endDate
+ required: 1
+ schema:
+ format: date
+ type: string
+ - description: This is an optional parameter. Maximum number of paths to retrieve. Default is 50.
+ in: query
+ name: limit
+ schema:
+ default: 50
+ type: integer
+ - description: This is an optional parameter. 0-indexed offset. Default is 0.
+ in: query
+ name: offset
+ schema:
+ type: string
+ - description: This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.
+ in: query
+ name: pagePath
+ schema:
+ type: string
+ responses:
+ 200:
+ content:
+ application/json:
+ schema:
+ properties:
+ items:
+ description: An array of Items for date resource.
+ items:
+ $ref: '#/components/schemas/statisticsyearweek'
+ type: array
+ totalResults:
+ description: The total number of paths.
+ type: integer
+ totals:
+ properties:
+ sessions:
+ description: The sum total of the sessions in the specified period.
+ type: integer
+ type: object
+ type: object
+ description: OK
+ 400:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Bad request
+ 401:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Invalid login
+ 404:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorContent'
+ description: Not Found
+ summary: Retrieve sessions count for each yearWeek from provider (e.g. Google Analytics V4)
+ tags:
+ - Statistics
+ '/sites/{site_id}/tags':
+ get:
+ parameters:
+ - in: path
+ name: site_id
+ required: 1
+ schema:
+ type: integer
+ - $ref: '#/components/parameters/tag_search'
+ - $ref: '#/components/parameters/tag_searchFields'
+ - $ref: '#/components/parameters/tag_limit'
+ - $ref: '#/components/parameters/tag_offset'
+ - $ref: '#/components/parameters/tag_sortBy'
+ - $ref: '#/components/parameters/tag_sortOrder'
+ - $ref: '#/components/parameters/tag_fields'
+ - $ref: '#/components/parameters/tag_dateField'
+ - $ref: '#/components/parameters/tag_dateFrom'
+ - $ref: '#/components/parameters/tag_dateTo'
+ responses:
+ 200:
+ content:
+ application/json:
schema:
properties:
items:
@@ -15505,8 +16472,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing tag
tags:
- Tags
@@ -15610,8 +16575,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing tag
tags:
- Tags
@@ -15635,6 +16598,8 @@ paths:
type: string
- $ref: '#/components/parameters/asset_limit'
- $ref: '#/components/parameters/asset_offset'
+ - $ref: '#/components/parameters/asset_filterKeys'
+ - $ref: '#/components/parameters/asset_searchFields'
- description: 'The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.'
in: query
name: class
@@ -15744,6 +16709,7 @@ paths:
- $ref: '#/components/parameters/entry_maxComments'
- $ref: '#/components/parameters/entry_maxTrackbacks'
- $ref: '#/components/parameters/entry_no_text_filter'
+ - $ref: '#/components/parameters/entry_filterKeys'
- $ref: '#/components/parameters/entry_dateField'
- $ref: '#/components/parameters/entry_dateFrom'
- $ref: '#/components/parameters/entry_dateTo'
@@ -15825,6 +16791,7 @@ paths:
- $ref: '#/components/parameters/page_maxComments'
- $ref: '#/components/parameters/page_maxTrackbacks'
- $ref: '#/components/parameters/page_no_text_filter'
+ - $ref: '#/components/parameters/page_filterKeys'
- $ref: '#/components/parameters/page_dateField'
- $ref: '#/components/parameters/page_dateFrom'
- $ref: '#/components/parameters/page_dateTo'
@@ -15886,6 +16853,7 @@ paths:
- $ref: '#/components/parameters/template_searchFields'
- $ref: '#/components/parameters/template_limit'
- $ref: '#/components/parameters/template_offset'
+ - $ref: '#/components/parameters/template_filterKeys'
- description: |
#### id
@@ -15977,8 +16945,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of templates in the specified site
tags:
- Templates
@@ -15995,6 +16961,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/template_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -16030,8 +16997,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new template
tags:
- Templates
@@ -16100,8 +17065,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found
- security:
- - mtauth: []
summary: Make a preview for a template
tags:
- Templates
@@ -16160,8 +17123,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a template
tags:
- Templates
@@ -16211,8 +17172,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Retrieve single template by its ID
tags:
- Templates
@@ -16237,6 +17196,7 @@ paths:
required: 1
schema:
type: integer
+ - $ref: '#/components/parameters/template_saveRevision'
requestBody:
content:
application/x-www-form-urlencoded:
@@ -16278,8 +17238,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a template
tags:
- Templates
@@ -16332,8 +17290,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Make a clone of a template
tags:
- Templates
@@ -16413,8 +17369,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Make a preview for a template with existing data
tags:
- Templates
@@ -16473,8 +17427,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Publish a template
tags:
- Templates
@@ -16531,8 +17483,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found
- security:
- - mtauth: []
summary: Reset template text to theme default or tempalte_set default
tags:
- Templates
@@ -16558,6 +17508,7 @@ paths:
- $ref: '#/components/parameters/templatemap_fields'
- $ref: '#/components/parameters/templatemap_includeIds'
- $ref: '#/components/parameters/templatemap_excludeIds'
+ - $ref: '#/components/parameters/templatemap_filterKeys'
- $ref: '#/components/parameters/templatemap_dateField'
- $ref: '#/components/parameters/templatemap_dateFrom'
- $ref: '#/components/parameters/templatemap_dateTo'
@@ -16597,8 +17548,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Retrieve a list of templatemaps in the specified site
tags:
- Templates
@@ -16650,8 +17599,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template not found.
- security:
- - mtauth: []
summary: Create a new templatemap
tags:
- Templates
@@ -16711,8 +17658,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing templatemap
tags:
- Templates
@@ -16761,8 +17706,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Template or TemplateMap not found.
- security:
- - mtauth: []
summary: Retrieve a single templatemap by its ID
tags:
- Templates
@@ -16829,8 +17772,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing templatemap
tags:
- Templates
@@ -16885,8 +17826,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of themes for site
tags:
- Themes
@@ -16936,8 +17875,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found.
- security:
- - mtauth: []
summary: Retrieve a single theme by its ID for site
tags:
- Themes
@@ -16990,8 +17927,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found
- security:
- - mtauth: []
summary: Apply a theme to site
tags:
- Themes
@@ -17051,8 +17986,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgets in the specified site
tags:
- Widgets
@@ -17098,8 +18031,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new widget
tags:
- Widgets
@@ -17153,8 +18084,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete a widget
tags:
- Widgets
@@ -17198,8 +18127,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found.
- security:
- - mtauth: []
summary: Retrieve a single widget by its ID
tags:
- Widgets
@@ -17260,8 +18187,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update a widget
tags:
- Widgets
@@ -17308,8 +18233,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found
- security:
- - mtauth: []
summary: Make a clone of a widget
tags:
- Widgets
@@ -17360,8 +18283,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found
- security:
- - mtauth: []
summary: Reset widget text to default
tags:
- Widgets
@@ -17421,8 +18342,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgetsets in the specified site
tags:
- WidgetSets
@@ -17468,8 +18387,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new widgetset
tags:
- WidgetSets
@@ -17523,8 +18440,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete an existing widgetset
tags:
- WidgetSets
@@ -17568,8 +18483,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or WidgetSet not found.
- security:
- - mtauth: []
summary: Retrieve a single widgetset by its ID
tags:
- WidgetSets
@@ -17630,8 +18543,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update an existing widgetset
tags:
- WidgetSets
@@ -17696,8 +18607,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or WidgetSet not found.
- security:
- - mtauth: []
summary: Retrieve a list of widgets in the specified widgetset
tags:
- Widgets
@@ -17748,8 +18657,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Widget not found.
- security:
- - mtauth: []
summary: Retrieve a single widget by widgetset ID
tags:
- Widgets
@@ -17838,8 +18745,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Retrieve a list of themes
tags:
- Themes
@@ -17894,8 +18799,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Uninstall a specified theme from the MT
tags:
- Themes
@@ -17939,8 +18842,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Theme not found.
- security:
- - mtauth: []
summary: Retrieve a single theme by its ID
tags:
- Themes
@@ -17982,8 +18883,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Invalidate current session. This is like logout
tags:
- Authentication
@@ -18060,6 +18959,7 @@ paths:
- $ref: '#/components/parameters/user_searchFields'
- $ref: '#/components/parameters/user_limit'
- $ref: '#/components/parameters/user_offset'
+ - $ref: '#/components/parameters/user_filterKeys'
- description: |
The field name for sort. You can specify one of following values
- id
@@ -18201,8 +19101,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site not found.
- security:
- - mtauth: []
summary: Create a new user
tags:
- Users
@@ -18229,8 +19127,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to export users.
- security:
- - mtauth: []
summary: Export users
tags:
- Users
@@ -18275,8 +19171,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to import users.
- security:
- - mtauth: []
summary: Import users
tags:
- Users
@@ -18306,8 +19200,6 @@ paths:
description: Invalid login
403:
description: Do not have permission to synchronize users.
- security:
- - mtauth: []
summary: Synchronize users
tags:
- Users
@@ -18362,8 +19254,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not DELETE or POST with __method=DELETE
- security:
- - mtauth: []
summary: Delete user
tags:
- Users
@@ -18473,8 +19363,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Request method is not PUT or POST with __method=PUT
- security:
- - mtauth: []
summary: Update user data
tags:
- Users
@@ -18493,6 +19381,7 @@ paths:
- $ref: '#/components/parameters/group_sortBy'
- $ref: '#/components/parameters/group_sortOrder'
- $ref: '#/components/parameters/group_fields'
+ - $ref: '#/components/parameters/group_filterKeys'
- $ref: '#/components/parameters/group_dateField'
- $ref: '#/components/parameters/group_dateFrom'
- $ref: '#/components/parameters/group_dateTo'
@@ -18532,8 +19421,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: User not found.
- security:
- - mtauth: []
summary: Retrieve a list of groups
tags:
- Users
@@ -18555,6 +19442,7 @@ paths:
- $ref: '#/components/parameters/permission_sortOrder'
- $ref: '#/components/parameters/permission_fields'
- $ref: '#/components/parameters/permission_blogIds'
+ - $ref: '#/components/parameters/permission_filterKeys'
- $ref: '#/components/parameters/permission_dateField'
- $ref: '#/components/parameters/permission_dateFrom'
- $ref: '#/components/parameters/permission_dateTo'
@@ -18594,8 +19482,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found.
- security:
- - mtauth: []
summary: Retrieve a list of permissions for user
tags:
- Users
@@ -18653,8 +19539,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Grant permissions to user
tags:
- Users
@@ -18712,8 +19596,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or Role or User not found
- security:
- - mtauth: []
summary: Revoke permissions from user
tags:
- Users
@@ -18764,8 +19646,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found
- security:
- - mtauth: []
summary: Send the link for password recovery to specified user by email
tags:
- Users
@@ -18929,8 +19809,6 @@ paths:
schema:
$ref: '#/components/schemas/ErrorContent'
description: Site or User not found
- security:
- - mtauth: []
summary: Unlock user account
tags:
- Users
@@ -18971,6 +19849,8 @@ paths:
summary: Get server API version
tags:
- Common API
+security:
+ - mtauth: []
servers:
- url: https://example.com/mt/mt-data-api.cgi/v7
tags:
From c551bd37d34ba65feb8871e986f0565be8c1b70f Mon Sep 17 00:00:00 2001
From: Masahiro Iuchi
Date: Wed, 20 Aug 2025 23:00:30 +0900
Subject: [PATCH 2/5] npm audit fix
---
package-lock.json | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/package-lock.json b/package-lock.json
index 3c29f64..7027448 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1511,9 +1511,9 @@
}
},
"node_modules/brace-expansion": {
- "version": "2.0.1",
- "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz",
- "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==",
+ "version": "2.0.2",
+ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz",
+ "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==",
"dev": true,
"license": "MIT",
"dependencies": {
@@ -2849,9 +2849,9 @@
"license": "BSD-2-Clause"
},
"node_modules/glob/node_modules/brace-expansion": {
- "version": "1.1.11",
- "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
- "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==",
+ "version": "1.1.12",
+ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.12.tgz",
+ "integrity": "sha512-9T9UjW3r0UW5c1Q7GTwllptXwhvYmEzFhzMfZ9H7FQWt+uZePjZPjBP/W1ZEyZ1twGWom5/56TF4lPcqjnDHcg==",
"dev": true,
"license": "MIT",
"dependencies": {
From c57b05bf57b934b160bba912ad9b64d800572681 Mon Sep 17 00:00:00 2001
From: Masahiro Iuchi
Date: Wed, 20 Aug 2025 23:04:48 +0900
Subject: [PATCH 3/5] make build
---
docs/v1.html | 2028 ++++-
docs/v2.html | 5121 +++++++++++-
docs/v3.html | 5051 +++++++++++-
docs/v4.html | 6500 ++++++++++++++-
docs/v5.html | 6525 ++++++++++++++-
docs/v6.html | 6537 +++++++++++++++-
docs/v7.html | 20901 ++++++++++++++++++++++++++++++++++++++++++-------
7 files changed, 48789 insertions(+), 3874 deletions(-)
diff --git a/docs/v1.html b/docs/v1.html
index 24bcbdf..0edffcd 100644
--- a/docs/v1.html
+++ b/docs/v1.html
@@ -3293,7 +3293,7 @@
Movable Type Data API
- (8.6.0)
+ (8.7.0)
Download OpenAPI specification:
@@ -4071,6 +4071,31 @@
Notes
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
header
@@ -4453,6 +4478,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
Request Body schema:
Return authorization(login) form as HTML.
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
query
@@ -5614,6 +5689,31 @@
MTAuth sessionId={retrieved sessionId}
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
header
@@ -5977,6 +6077,31 @@
Retrieve a list of categories.
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -6078,7 +6203,7 @@ label
-
+
descend
+
+
+ limit
+
+
+
+
+ integer
+
+
+
+ Default:
+
+ 10
+
+
+
+
Maximum number of categories to retrieve.
+
Default : 10
+
+
+
+
+
+
+
+ offset
+
+
+
+
+ integer
+
+
+
+ Default:
+
+ 0
+
+
+
+
0-indexed offset.
+
Default : 0
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "label,basename"
+
+
+
+
+ The comma separated field name list to search.
+
+
Default : label,basename
+
+
+
+
+
@@ -6712,6 +6962,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -6964,7 +7239,7 @@ Spam
-
+
Spam
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status,entryStatus"
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "body"
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "id"
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "descend"
+
+
+
+
+
@@ -8482,6 +8901,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -9901,6 +10345,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -10014,7 +10483,7 @@
-
+
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "body"
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "id"
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "descend"
+
+
+
+
+
@@ -12228,6 +12841,31 @@
>Retrieve OpenAPI schema
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
Responses
@@ -12472,6 +13110,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
Responses
@@ -12744,6 +13407,31 @@
Retrieve a list of endpoints.
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
query
@@ -13717,6 +14405,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -14250,7 +14963,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -15897,6 +16653,58 @@
+
+
+ query
+ Parameters
+
+
+
+
+
+ saveRevision
+
+
+
+
+ integer
+
+
+
+ Enum:
+ 0
+ 1
+
+
+
+
Save a revision or not
+
+
+
+
+
+
+
+
Request Body schema:
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -20169,6 +21002,58 @@
+
+
+ query
+ Parameters
+
+
+
+
+
+ saveRevision
+
+
+
+
+ integer
+
+
+
+ Enum:
+ 0
+ 1
+
+
+
+
Save a revision or not
+
+
+
+
+
+
+
+
Request Body schema:
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -21621,7 +22531,7 @@
-
+
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "body"
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "id"
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "descend"
+
+
+
+
+
@@ -23923,7 +24977,7 @@
-
+
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
+
+
+ limit
+
+
+
+
+ integer
+
+
+
+ Default:
+
+ 25
+
+
+
+
+ Maximum number of permissions to retrieve.
+
+
Default : 25
+
+
+
+
+
+
+
+ offset
+
+
+
+
+ integer
+
+
+
+ Default:
+
+ 0
+
+
+
+
0-indexed offset.
+
Default : 0
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blog_id"
+
+
+
+ Enum:
+ "id"
+ "blog_id"
+ "author_id"
+ "created_by"
+ "created_on"
+
+
+
+
+ The field name for sort. You can specify one
+ of following values
+
+
+ id
+ blog_id
+ author_id
+ created_by
+ created_on
+
+
Default : blog_id
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "ascend"
+
+
+
+ Enum:
+ "descend"
+ "ascend"
+
+
+
+
descend
+
Return permissions in descending order.
+
ascend
+
Return permissions in ascending order.
+
Default : ascend
+
+
+
+
+
@@ -24818,6 +26135,31 @@
>Retrieve a single blog by its ID
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -25264,6 +26606,31 @@
Retrieve a list of blogs by user.
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -26144,12 +27511,12 @@
- This is an required parameter. Start date of
+ This is a required parameter. Start date of
data. The format is "YYYY-MM-DD".
@@ -26183,12 +27550,12 @@
- This is an required parameter. End date of
+ This is a required parameter. End date of
data. The format is "YYYY-MM-DD".
@@ -26331,15 +27698,15 @@
This is an optional parameter. If true is
given, the MT can return total pageviews for
- each uniqueness paths. However, that data does
- not contain page title because its spec.
+ each unique path. However, that data does not
+ contain page title because of its spec.
(Sometimes, Google Analytics will return
another pageviews by same path.)
@@ -26850,12 +28217,12 @@
- This is an required parameter. Start date of
+ This is a required parameter. Start date of
data. The format is "YYYY-MM-DD".
@@ -26889,12 +28256,12 @@
- This is an required parameter. End date of
+ This is a required parameter. End date of
data. The format is "YYYY-MM-DD".
@@ -27507,12 +28874,12 @@
- This is an required parameter. Start date of
+ This is a required parameter. Start date of
data. The format is "YYYY-MM-DD".
@@ -27546,12 +28913,12 @@
- This is an required parameter. End date of
+ This is a required parameter. End date of
data. The format is "YYYY-MM-DD".
@@ -27694,15 +29061,15 @@
This is an optional parameter. If true is
given, the MT can return total pageviews for
- each uniqueness paths. However, that data does
- not contain page title because its spec.
+ each unique path. However, that data does not
+ contain page title because of its spec.
(Sometimes, Google Analytics will return
another pageviews by same path.)
@@ -28358,12 +29725,12 @@
- This is an required parameter. Start date of
+ This is a required parameter. Start date of
data. The format is "YYYY-MM-DD".
@@ -28397,12 +29764,12 @@
- This is an required parameter. End date of
+ This is a required parameter. End date of
data. The format is "YYYY-MM-DD".
@@ -29704,6 +31071,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -30856,7 +32248,7 @@
-
+
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
+
+
+ limit
+
+
+
+
+ integer
+
+
+
+ Default:
+
+ 25
+
+
+
+
+ Maximum number of permissions to retrieve.
+
+
Default : 25
+
+
+
+
+
+
+
+ offset
+
+
+
+
+ integer
+
+
+
+ Default:
+
+ 0
+
+
+
+
0-indexed offset.
+
Default : 0
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blog_id"
+
+
+
+ Enum:
+ "id"
+ "blog_id"
+ "author_id"
+ "created_by"
+ "created_on"
+
+
+
+
+ The field name for sort. You can specify one
+ of following values
+
+
+ id
+ blog_id
+ author_id
+ created_by
+ created_on
+
+
Default : blog_id
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "ascend"
+
+
+
+ Enum:
+ "descend"
+ "ascend"
+
+
+
+
descend
+
Return permissions in descending order.
+
ascend
+
Return permissions in ascending order.
+
Default : ascend
+
+
+
+
+
@@ -31308,6 +32963,31 @@
Retrieve a list of blogs by user.
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -32052,6 +33732,76 @@
data: {
components: {
parameters: {
+ category_excludeIds: {
+ description:
+ "The comma separated ID list of categories to exclude from result.",
+ in: "query",
+ name: "excludeIds",
+ schema: { type: "string" },
+ },
+ category_fields: {
+ description:
+ "The field list to retrieve as part of the category resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.",
+ in: "query",
+ name: "fields",
+ schema: { type: "string" },
+ },
+ category_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
+ category_includeIds: {
+ description:
+ "The comma separated ID list of categories to include to result.",
+ in: "query",
+ name: "includeIds",
+ schema: { type: "string" },
+ },
+ category_limit: {
+ description:
+ "Maximum number of categories to retrieve.\n\n**Default**: 10",
+ in: "query",
+ name: "limit",
+ schema: { default: 10, type: "integer" },
+ },
+ category_offset: {
+ description: "0-indexed offset.\n\n**Default**: 0",
+ in: "query",
+ name: "offset",
+ schema: { default: 0, type: "integer" },
+ },
+ category_search: {
+ description: "Search query.",
+ in: "query",
+ name: "search",
+ schema: { type: "string" },
+ },
+ category_searchFields: {
+ description:
+ "The comma separated field name list to search.\n\n**Default**: label,basename",
+ in: "query",
+ name: "searchFields",
+ schema: { default: "label,basename", type: "string" },
+ },
+ category_sortBy: {
+ description: "\n\n**Default**: user_custom",
+ in: "query",
+ name: "sortBy",
+ schema: { default: "user_custom", type: "string" },
+ },
+ category_sortOrder: {
+ description:
+ "#### descend\n\nReturn categories in descending order.\n\n#### ascend\n\nReturn categories in ascending order.\n\n\n\n**Default**: ascend",
+ in: "query",
+ name: "sortOrder",
+ schema: {
+ default: "ascend",
+ enum: ["descend", "ascend"],
+ type: "string",
+ },
+ },
comment_excludeIds: {
description:
"The comma separated ID list of comments to exclude from result.",
@@ -32066,6 +33816,13 @@
name: "fields",
schema: { type: "string" },
},
+ comment_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: status",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "status", type: "string" },
+ },
comment_includeIds: {
description:
"The comma separated ID list of comments to include to result.",
@@ -32130,6 +33887,13 @@
name: "fields",
schema: { type: "string" },
},
+ entry_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: status",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "status", type: "string" },
+ },
entry_includeIds: {
description:
"The comma separated ID list of entries to include to result.",
@@ -32171,6 +33935,12 @@
name: "offset",
schema: { default: 0, type: "integer" },
},
+ entry_saveRevision: {
+ description: "Save a revision or not",
+ in: "query",
+ name: "saveRevision",
+ schema: { enum: [0, 1], type: "integer" },
+ },
entry_search: {
description: "Search query.",
in: "query",
@@ -32226,6 +33996,98 @@
type: "string",
},
},
+ field_filterKeys: {},
+ field_searchFields: {},
+ field_sortBy: {},
+ field_sortOrder: {},
+ permission_blogIds: {
+ description:
+ "The comma-separated blog id list that to be included in the result.",
+ in: "query",
+ name: "blogIds",
+ schema: { type: "string" },
+ },
+ permission_excludeIds: {
+ description:
+ "The comma separated ID list of permissions to exclude from result.",
+ in: "query",
+ name: "excludeIds",
+ schema: { type: "string" },
+ },
+ permission_fields: {
+ description:
+ "The field list to retrieve as part of the permission resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.",
+ in: "query",
+ name: "fields",
+ schema: { type: "string" },
+ },
+ permission_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: blogIds",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "blogIds", type: "string" },
+ },
+ permission_includeIds: {
+ description:
+ "The comma separated ID list of permissions to include to result.",
+ in: "query",
+ name: "includeIds",
+ schema: { type: "string" },
+ },
+ permission_limit: {
+ description:
+ "Maximum number of permissions to retrieve.\n\n**Default**: 25",
+ in: "query",
+ name: "limit",
+ schema: { default: 25, type: "integer" },
+ },
+ permission_offset: {
+ description: "0-indexed offset.\n\n**Default**: 0",
+ in: "query",
+ name: "offset",
+ schema: { default: 0, type: "integer" },
+ },
+ permission_search: {
+ description: "Search query.",
+ in: "query",
+ name: "search",
+ schema: { type: "string" },
+ },
+ permission_searchFields: {
+ description: "The comma separated field name list to search.",
+ in: "query",
+ name: "searchFields",
+ schema: { type: "string" },
+ },
+ permission_sortBy: {
+ description:
+ "The field name for sort. You can specify one of following values\n\n- id\n- blog_id\n- author_id\n- created_by\n- created_on\n\n\n**Default**: blog_id",
+ in: "query",
+ name: "sortBy",
+ schema: {
+ default: "blog_id",
+ enum: [
+ "id",
+ "blog_id",
+ "author_id",
+ "created_by",
+ "created_on",
+ ],
+ type: "string",
+ },
+ },
+ permission_sortOrder: {
+ description:
+ "#### descend\n\nReturn permissions in descending order.\n\n#### ascend\n\nReturn permissions in ascending order.\n\n\n\n**Default**: ascend",
+ in: "query",
+ name: "sortOrder",
+ schema: {
+ default: "ascend",
+ enum: ["descend", "ascend"],
+ type: "string",
+ },
+ },
site_excludeIds: {
description:
"The comma separated ID list of sites to exclude from result.",
@@ -32240,6 +34102,12 @@
name: "fields",
schema: { type: "string" },
},
+ site_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
site_includeIds: {
description:
"The comma separated ID list of sites to include to result.",
@@ -32722,7 +34590,7 @@
description: "Find out more about Movable Type Data API",
url: "https://www.movabletype.jp/developers/data-api/",
},
- info: { title: "Movable Type Data API", version: "8.6.0" },
+ info: { title: "Movable Type Data API", version: "8.7.0" },
openapi: "3.0.0",
paths: {
"/": {
@@ -33117,7 +34985,6 @@
},
403: { description: "Do not have permission to publish." },
},
- security: [{ mtauth: [] }],
summary:
"Rebuild the static archives in relation to specified entries",
tags: ["Entries", "Publish"],
@@ -33289,7 +35156,6 @@
description: "Conflict",
},
},
- security: [{ mtauth: [] }],
summary: "Upload a file",
tags: ["Assets"],
},
@@ -33321,6 +35187,9 @@
name: "sortOrder",
schema: { enum: ["ascend", "descend"], type: "string" },
},
+ { $ref: "#/components/parameters/category_limit" },
+ { $ref: "#/components/parameters/category_offset" },
+ { $ref: "#/components/parameters/category_searchFields" },
],
responses: {
200: {
@@ -33444,6 +35313,30 @@
type: "string",
},
},
+ { $ref: "#/components/parameters/field_filterKeys" },
+ { $ref: "#/components/parameters/field_searchFields" },
+ { $ref: "#/components/parameters/field_sortBy" },
+ { $ref: "#/components/parameters/field_sortOrder" },
+ {
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "status,entryStatus", type: "string" },
+ },
+ {
+ in: "query",
+ name: "searchFields",
+ schema: { default: "body", type: "string" },
+ },
+ {
+ in: "query",
+ name: "sortBy",
+ schema: { default: "id", type: "string" },
+ },
+ {
+ in: "query",
+ name: "sortOrder",
+ schema: { default: "descend", type: "string" },
+ },
],
responses: {
200: {
@@ -33567,7 +35460,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete a comment",
tags: ["Comments"],
},
@@ -33713,7 +35605,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update a comment",
tags: ["Comments"],
},
@@ -33837,6 +35728,7 @@
name: "fields",
schema: { type: "string" },
},
+ { $ref: "#/components/parameters/entry_filterKeys" },
],
responses: {
200: {
@@ -33902,6 +35794,7 @@
required: 1,
schema: { type: "integer" },
},
+ { $ref: "#/components/parameters/entry_saveRevision" },
],
requestBody: {
content: {
@@ -33954,7 +35847,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new entry",
tags: ["Entries"],
},
@@ -34023,7 +35915,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete an entry",
tags: ["Entries"],
},
@@ -34128,6 +36019,7 @@
required: 1,
schema: { type: "integer" },
},
+ { $ref: "#/components/parameters/entry_saveRevision" },
],
requestBody: {
content: {
@@ -34189,7 +36081,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update an entry",
tags: ["Entries"],
},
@@ -34231,6 +36122,30 @@
name: "offset",
schema: { type: "integer" },
},
+ { $ref: "#/components/parameters/field_filterKeys" },
+ { $ref: "#/components/parameters/field_searchFields" },
+ { $ref: "#/components/parameters/field_sortBy" },
+ { $ref: "#/components/parameters/field_sortOrder" },
+ {
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "status", type: "string" },
+ },
+ {
+ in: "query",
+ name: "searchFields",
+ schema: { default: "body", type: "string" },
+ },
+ {
+ in: "query",
+ name: "sortBy",
+ schema: { default: "id", type: "string" },
+ },
+ {
+ in: "query",
+ name: "sortOrder",
+ schema: { default: "descend", type: "string" },
+ },
],
responses: {
200: {
@@ -34357,7 +36272,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new comment on an entry",
tags: ["Comments", "Entries"],
},
@@ -34445,7 +36359,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary: "Reply to specified comment",
tags: ["Comments", "Entries"],
},
@@ -34463,7 +36376,7 @@
},
{
description:
- 'This is an required parameter. Start date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. Start date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "startDate",
required: 1,
@@ -34471,7 +36384,7 @@
},
{
description:
- 'This is an required parameter. End date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. End date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "endDate",
required: 1,
@@ -34500,7 +36413,7 @@
},
{
description:
- "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
in: "query",
name: "uniquePath",
schema: { enum: [0, 1], type: "integer" },
@@ -34566,7 +36479,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary:
"Retrieve pageviews count for each date from provider (e.g. Google Analytics)",
tags: ["Statistics"],
@@ -34585,7 +36497,7 @@
},
{
description:
- 'This is an required parameter. Start date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. Start date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "startDate",
required: 1,
@@ -34593,7 +36505,7 @@
},
{
description:
- 'This is an required parameter. End date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. End date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "endDate",
required: 1,
@@ -34681,7 +36593,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary:
"Retrieve visits count for each date from provider (e.g. Google Analytics)",
tags: ["Statistics"],
@@ -34700,7 +36611,7 @@
},
{
description:
- 'This is an required parameter. Start date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. Start date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "startDate",
required: 1,
@@ -34708,7 +36619,7 @@
},
{
description:
- 'This is an required parameter. End date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. End date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "endDate",
required: 1,
@@ -34737,7 +36648,7 @@
},
{
description:
- "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
in: "query",
name: "uniquePath",
schema: { enum: [0, 1], type: "integer" },
@@ -34803,7 +36714,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary:
"Retrieve pageviews count for each path from provider (e.g. Google Analytics)",
tags: ["Statistics"],
@@ -34822,7 +36732,7 @@
},
{
description:
- 'This is an required parameter. Start date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. Start date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "startDate",
required: 1,
@@ -34830,7 +36740,7 @@
},
{
description:
- 'This is an required parameter. End date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. End date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "endDate",
required: 1,
@@ -34918,7 +36828,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary:
"Retrieve visits count for each path from provider (e.g. Google Analytics)",
tags: ["Statistics"],
@@ -34973,7 +36882,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a current effective provider",
tags: ["Statistics"],
},
@@ -35026,7 +36934,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Invalidate current session. This is like logout",
tags: ["Authentication"],
},
@@ -35135,7 +37042,6 @@
"Do not have permission to synchronize users.",
},
},
- security: [{ mtauth: [] }],
summary: "Synchronize users",
tags: ["Users"],
},
@@ -35278,7 +37184,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update user data",
tags: ["Users"],
},
@@ -35301,6 +37206,11 @@
name: "blogIds",
schema: { type: "string" },
},
+ { $ref: "#/components/parameters/permission_filterKeys" },
+ { $ref: "#/components/parameters/permission_limit" },
+ { $ref: "#/components/parameters/permission_offset" },
+ { $ref: "#/components/parameters/permission_sortBy" },
+ { $ref: "#/components/parameters/permission_sortOrder" },
],
responses: {
200: {
@@ -35355,7 +37265,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of permissions for a user",
tags: ["Users", "Permissions"],
},
@@ -35518,6 +37427,7 @@
},
},
},
+ security: [{ mtauth: [] }],
servers: [{ url: "https://example.com/mt/mt-data-api.cgi/v1" }],
tags: [
{ name: "Authentication" },
diff --git a/docs/v2.html b/docs/v2.html
index a94c5b2..1d16492 100644
--- a/docs/v2.html
+++ b/docs/v2.html
@@ -7888,7 +7888,7 @@
Movable Type Data API
- (8.6.0)
+ (8.7.0)
Download OpenAPI specification:
@@ -9067,6 +9067,31 @@
>Retrieve assets in the specified site
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -9271,6 +9296,49 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "class"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : class
+
+
+
+
+
>Retrieve single asset by its ID
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -14323,6 +14416,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -14946,7 +15064,7 @@ Unpublish
-
+
Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -17346,6 +17507,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -17969,7 +18155,7 @@ Unpublish
-
+
Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -19778,6 +20007,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -20330,6 +20584,31 @@
>Retrieve assets that related with specified entry
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -20656,7 +20935,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "class"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : class
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "label"
+
+
+
+
+ The comma separated field name list to search.
+
+
Default : label
+
+
+
+
+
@@ -21686,6 +22051,31 @@
>Retrieve assets that related with specified page
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -21847,6 +22237,92 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "class"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : class
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "label"
+
+
+
+
+ The comma separated field name list to search.
+
+
Default : label
+
+
+
+
+
>Retrieve assets that related with specified tag
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -23203,6 +23704,92 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "class"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : class
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "label"
+
+
+
+
+ The comma separated field name list to search.
+
+
Default : label
+
+
+
+
+
Notes
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
header
@@ -24839,6 +25451,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
Request Body schema:
Return authorization(login) form as HTML.
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
query
@@ -26000,6 +26662,31 @@
MTAuth sessionId={retrieved sessionId}
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
header
@@ -26756,6 +27443,31 @@
>Retrieve categories in the specified site
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -30383,6 +31095,31 @@
>Retrieve single category by its ID
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -31971,6 +32708,31 @@
>Retrieve child categories from the specified category
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -32989,6 +33751,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -33612,7 +34399,7 @@ Unpublish
-
+
Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -35981,6 +36811,31 @@
>Retrieve parent categories from the specified category
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -36967,6 +37822,31 @@
>Retrieve siblings categories from the specified category
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -38342,6 +39222,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -39770,6 +40675,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -40022,7 +40952,7 @@ Spam
-
+
Spam
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "systemObject,type"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default : systemObject,type
+
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name,basename,description,tag"
+
+
+
+
+ The comma separated field name list to search.
+
+
+ Default :
+ name,basename,description,tag
+
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name"
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "ascend"
+
+
+
+ Enum:
+ "descend"
+ "ascend"
+
+
+
+
descend
+
Return fields in descending order.
+
ascend
+
Return fields in ascending order.
+
Default : ascend
+
+
+
+
+
@@ -41860,6 +42978,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -43547,6 +44690,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -43660,7 +44828,7 @@
-
+
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "systemObject,type"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default : systemObject,type
+
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name,basename,description,tag"
+
+
+
+
+ The comma separated field name list to search.
+
+
+ Default :
+ name,basename,description,tag
+
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name"
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "ascend"
+
+
+
+ Enum:
+ "descend"
+ "ascend"
+
+
+
+
descend
+
Return fields in descending order.
+
ascend
+
Return fields in ascending order.
+
Default : ascend
+
+
+
+
+
@@ -46323,6 +47679,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -46436,7 +47817,7 @@
-
+
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "systemObject,type"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default : systemObject,type
+
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name,basename,description,tag"
+
+
+
+
+ The comma separated field name list to search.
+
+
+ Default :
+ name,basename,description,tag
+
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name"
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "ascend"
+
+
+
+ Enum:
+ "descend"
+ "ascend"
+
+
+
+
descend
+
Return fields in descending order.
+
ascend
+
Return fields in ascending order.
+
Default : ascend
+
+
+
+
+
@@ -49104,6 +50673,31 @@
>Retrieve OpenAPI schema
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
Responses
@@ -49348,6 +50942,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
Responses
@@ -49940,7 +51559,7 @@
ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "systemObject,type"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default : systemObject,type
+
+
+
+
+
+
@@ -53277,6 +54941,31 @@
Retrieve a list of endpoints.
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
query
@@ -54269,6 +55958,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -54892,7 +56606,7 @@ Unpublish
-
+
Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -57293,6 +59050,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -57916,7 +59698,7 @@ Unpublish
-
+
Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -60298,6 +62123,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -60831,7 +62681,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -63288,6 +65181,58 @@
+
+
+ query
+ Parameters
+
+
+
+
+
+ saveRevision
+
+
+
+
+ integer
+
+
+
+ Enum:
+ 0
+ 1
+
+
+
+
Save a revision or not
+
+
+
+
+
+
+
+
Request Body schema:
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -71380,6 +73350,58 @@
+
+
+ query
+ Parameters
+
+
+
+
+
+ saveRevision
+
+
+
+
+ integer
+
+
+
+ Enum:
+ 0
+ 1
+
+
+
+
Save a revision or not
+
+
+
+
+
+
+
+
Request Body schema:
>Retrieve assets that related with specified entry
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -73784,7 +75831,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "class"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : class
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "label"
+
+
+
+
+ The comma separated field name list to search.
+
+
Default : label
+
+
+
+
+
@@ -74827,6 +76960,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -74940,7 +77098,7 @@
-
+
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "systemObject,type"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default : systemObject,type
+
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name,basename,description,tag"
+
+
+
+
+ The comma separated field name list to search.
+
+
+ Default :
+ name,basename,description,tag
+
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name"
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "ascend"
+
+
+
+ Enum:
+ "descend"
+ "ascend"
+
+
+
+
descend
+
Return fields in descending order.
+
ascend
+
Return fields in ascending order.
+
Default : ascend
+
+
+
+
+
@@ -78181,6 +80527,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -78804,7 +81175,7 @@ Unpublish
-
+
Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -81203,6 +83617,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -84836,6 +87275,31 @@
>Retrieve single folder by its ID
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -86460,6 +88924,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -87450,6 +89939,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -88073,7 +90587,7 @@ Unpublish
-
+
Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -89881,6 +92438,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -90852,6 +93434,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -96215,7 +98822,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -99998,7 +102648,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -103724,7 +106417,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
@@ -105619,7 +108355,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -106996,6 +109775,49 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "level"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : level
+
+
+
+
+
Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -111508,7 +114355,7 @@ Unpublish
-
+
Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -113335,6 +116225,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -113958,7 +116873,7 @@ Unpublish
-
+
Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -115785,6 +118743,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -116377,7 +119360,7 @@ Unpublish
-
+
Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -118267,6 +121293,58 @@
+
+
+ query
+ Parameters
+
+
+
+
+
+ saveRevision
+
+
+
+
+ integer
+
+
+
+ Enum:
+ 0
+ 1
+
+
+
+
Save a revision or not
+
+
+
+
+
+
+
+
Request Body schema:
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -123638,6 +126741,58 @@
+
+
+ query
+ Parameters
+
+
+
+
+
+ saveRevision
+
+
+
+
+ integer
+
+
+
+ Enum:
+ 0
+ 1
+
+
+
+
Save a revision or not
+
+
+
+
+
+
+
+
Request Body schema:
>Retrieve assets that related with specified page
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -125332,6 +128512,92 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "class"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : class
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "label"
+
+
+
+
+ The comma separated field name list to search.
+
+
Default : label
+
+
+
+
+
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -126653,7 +129944,7 @@
-
+
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "systemObject,type"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default : systemObject,type
+
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name,basename,description,tag"
+
+
+
+
+ The comma separated field name list to search.
+
+
+ Default :
+ name,basename,description,tag
+
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name"
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "ascend"
+
+
+
+ Enum:
+ "descend"
+ "ascend"
+
+
+
+
descend
+
Return fields in descending order.
+
ascend
+
Return fields in ascending order.
+
Default : ascend
+
+
+
+
+
@@ -129892,6 +133371,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -130515,7 +134019,7 @@ Unpublish
-
+
Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -132676,7 +136223,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
@@ -134545,7 +138135,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
@@ -135583,7 +139216,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
@@ -138521,7 +142197,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
@@ -146944,7 +150663,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
@@ -147651,6 +151413,31 @@
>Searching entries
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
query
@@ -150344,6 +154131,31 @@
>Retrieve sites
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
query
@@ -155488,6 +159300,31 @@
>Retrieve a single blog by its ID
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -160400,6 +164237,31 @@
>Retrieve sites by parent ID
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -164588,6 +168450,31 @@
Retrieve a list of blogs by user.
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -166910,12 +170797,12 @@
- This is an required parameter. Start date of
+ This is a required parameter. Start date of
data. The format is "YYYY-MM-DD".
@@ -166949,12 +170836,12 @@
- This is an required parameter. End date of
+ This is a required parameter. End date of
data. The format is "YYYY-MM-DD".
@@ -167097,15 +170984,15 @@
This is an optional parameter. If true is
given, the MT can return total pageviews for
- each uniqueness paths. However, that data does
- not contain page title because its spec.
+ each unique path. However, that data does not
+ contain page title because of its spec.
(Sometimes, Google Analytics will return
another pageviews by same path.)
@@ -167616,12 +171503,12 @@
- This is an required parameter. Start date of
+ This is a required parameter. Start date of
data. The format is "YYYY-MM-DD".
@@ -167655,12 +171542,12 @@
- This is an required parameter. End date of
+ This is a required parameter. End date of
data. The format is "YYYY-MM-DD".
@@ -168273,12 +172160,12 @@
- This is an required parameter. Start date of
+ This is a required parameter. Start date of
data. The format is "YYYY-MM-DD".
@@ -168312,12 +172199,12 @@
- This is an required parameter. End date of
+ This is a required parameter. End date of
data. The format is "YYYY-MM-DD".
@@ -168460,15 +172347,15 @@
This is an optional parameter. If true is
given, the MT can return total pageviews for
- each uniqueness paths. However, that data does
- not contain page title because its spec.
+ each unique path. However, that data does not
+ contain page title because of its spec.
(Sometimes, Google Analytics will return
another pageviews by same path.)
@@ -169124,12 +173011,12 @@
- This is an required parameter. Start date of
+ This is a required parameter. Start date of
data. The format is "YYYY-MM-DD".
@@ -169163,12 +173050,12 @@
- This is an required parameter. End date of
+ This is a required parameter. End date of
data. The format is "YYYY-MM-DD".
@@ -170184,6 +174071,31 @@
>Retrieve a list of tags that related with specific site
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -171501,6 +175413,31 @@
>Retrieve a single tag by its ID
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -172574,6 +176511,31 @@
>Retrieve assets that related with specified tag
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -172735,6 +176697,92 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "class"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : class
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "label"
+
+
+
+
+ The comma separated field name list to search.
+
+
Default : label
+
+
+
+
+
Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -174585,7 +178658,7 @@ Unpublish
-
+
Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -176985,6 +181101,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -177608,7 +181749,7 @@ Unpublish
-
+
Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -179841,7 +184025,7 @@
ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "archiveType,buildType,isPreferred"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default :
+ archiveType,buildType,isPreferred
+
+
+
+
+
+
@@ -183126,6 +187356,49 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "type"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : type
+
+
+
+
+
+
+
+ query
+ Parameters
+
+
+
+
+
+ saveRevision
+
+
+
+
+ integer
+
+
+
+ Enum:
+ 0
+ 1
+
+
+
+
Save a revision or not
+
+
+
+
+
+
+
+
Request Body schema:
+
+
+ query
+ Parameters
+
+
+
+
+
+ saveRevision
+
+
+
+
+ integer
+
+
+
+ Enum:
+ 0
+ 1
+
+
+
+
Save a revision or not
+
+
+
+
+
+
+
+
Request Body schema:
ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "archiveType,buildType,isPreferred"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default :
+ archiveType,buildType,isPreferred
+
+
+
+
+
+
@@ -197081,6 +201504,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
Request Body schema:
Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
query
@@ -197642,6 +202115,49 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status,lockout"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status,lockout
+
+
+
+
+
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -203428,7 +207969,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
@@ -204466,7 +209050,7 @@ ascend
-
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
@@ -206447,6 +211074,31 @@
Retrieve a list of blogs by user.
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -225410,6 +230062,13 @@
name: "fields",
schema: { type: "string" },
},
+ asset_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: class",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "class", type: "string" },
+ },
asset_includeIds: {
description:
"The comma separated ID list of assets to include to result.",
@@ -225474,6 +230133,12 @@
name: "fields",
schema: { type: "string" },
},
+ category_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
category_includeIds: {
description:
"The comma separated ID list of categories to include to result.",
@@ -225538,6 +230203,13 @@
name: "fields",
schema: { type: "string" },
},
+ comment_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: status",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "status", type: "string" },
+ },
comment_includeIds: {
description:
"The comma separated ID list of comments to include to result.",
@@ -225602,6 +230274,13 @@
name: "fields",
schema: { type: "string" },
},
+ entry_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: status",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "status", type: "string" },
+ },
entry_includeIds: {
description:
"The comma separated ID list of entries to include to result.",
@@ -225643,6 +230322,12 @@
name: "offset",
schema: { default: 0, type: "integer" },
},
+ entry_saveRevision: {
+ description: "Save a revision or not",
+ in: "query",
+ name: "saveRevision",
+ schema: { enum: [0, 1], type: "integer" },
+ },
entry_search: {
description: "Search query.",
in: "query",
@@ -225712,6 +230397,13 @@
name: "fields",
schema: { type: "string" },
},
+ field_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: systemObject,type",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "systemObject,type", type: "string" },
+ },
field_includeIds: {
description:
"The comma separated ID list of fields to include to result.",
@@ -225779,6 +230471,12 @@
name: "fields",
schema: { type: "string" },
},
+ folder_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
folder_includeIds: {
description:
"The comma separated ID list of folders to include to result.",
@@ -225843,6 +230541,12 @@
name: "fields",
schema: { type: "string" },
},
+ formatted_text_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
formatted_text_includeIds: {
description:
"The comma separated ID list of formatted_texts to include to result.",
@@ -225907,6 +230611,13 @@
name: "fields",
schema: { type: "string" },
},
+ group_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: status",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "status", type: "string" },
+ },
group_includeIds: {
description:
"The comma separated ID list of groups to include to result.",
@@ -225974,6 +230685,13 @@
name: "fields",
schema: { type: "string" },
},
+ log_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: level",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "level", type: "string" },
+ },
log_includeIds: {
description:
"The comma separated ID list of logs to include to result.",
@@ -226038,6 +230756,13 @@
name: "fields",
schema: { type: "string" },
},
+ page_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: status",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "status", type: "string" },
+ },
page_includeIds: {
description:
"The comma separated ID list of pages to include to result.",
@@ -226079,6 +230804,12 @@
name: "offset",
schema: { default: 0, type: "integer" },
},
+ page_saveRevision: {
+ description: "Save a revision or not",
+ in: "query",
+ name: "saveRevision",
+ schema: { enum: [0, 1], type: "integer" },
+ },
page_search: {
description: "Search query.",
in: "query",
@@ -226155,6 +230886,13 @@
name: "fields",
schema: { type: "string" },
},
+ permission_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: blogIds",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "blogIds", type: "string" },
+ },
permission_includeIds: {
description:
"The comma separated ID list of permissions to include to result.",
@@ -226229,6 +230967,12 @@
name: "fields",
schema: { type: "string" },
},
+ role_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
role_includeIds: {
description:
"The comma separated ID list of roles to include to result.",
@@ -226304,6 +231048,12 @@
name: "fields",
schema: { type: "string" },
},
+ site_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
site_includeIds: {
description:
"The comma separated ID list of sites to include to result.",
@@ -226369,6 +231119,12 @@
name: "fields",
schema: { type: "string" },
},
+ tag_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
tag_includeIds: {
description:
"The comma separated ID list of tags to include to result.",
@@ -226433,6 +231189,13 @@
name: "fields",
schema: { type: "string" },
},
+ template_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: type",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "type", type: "string" },
+ },
template_includeIds: {
description:
"The comma separated ID list of templates to include to result.",
@@ -226453,6 +231216,12 @@
name: "offset",
schema: { default: 0, type: "integer" },
},
+ template_saveRevision: {
+ description: "Save a revision or not",
+ in: "query",
+ name: "saveRevision",
+ schema: { enum: [0, 1], type: "integer" },
+ },
template_search: {
description: "Search query.",
in: "query",
@@ -226497,6 +231266,16 @@
name: "fields",
schema: { type: "string" },
},
+ templatemap_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: archiveType,buildType,isPreferred",
+ in: "query",
+ name: "filterKeys",
+ schema: {
+ default: "archiveType,buildType,isPreferred",
+ type: "string",
+ },
+ },
templatemap_includeIds: {
description:
"The comma separated ID list of templatemaps to include to result.",
@@ -226560,6 +231339,13 @@
name: "fields",
schema: { type: "string" },
},
+ user_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: status,lockout",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "status,lockout", type: "string" },
+ },
user_includeIds: {
description:
"The comma separated ID list of users to include to result.",
@@ -226627,6 +231413,12 @@
name: "fields",
schema: { type: "string" },
},
+ widget_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
widget_includeIds: {
description:
"The comma separated ID list of widgets to include to result.",
@@ -226691,6 +231483,12 @@
name: "fields",
schema: { type: "string" },
},
+ widgetset_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
widgetset_includeIds: {
description:
"The comma separated ID list of widgetsets to include to result.",
@@ -228306,7 +233104,7 @@
description: "Find out more about Movable Type Data API",
url: "https://www.movabletype.jp/developers/data-api/",
},
- info: { title: "Movable Type Data API", version: "8.6.0" },
+ info: { title: "Movable Type Data API", version: "8.7.0" },
openapi: "3.0.0",
paths: {
"/": {
@@ -228462,7 +233260,6 @@
"Upload file size is larger than CGIMaxUpload.",
},
},
- security: [{ mtauth: [] }],
summary: "Upload a file",
tags: ["Assets"],
},
@@ -228759,6 +233556,7 @@
{ $ref: "#/components/parameters/group_sortBy" },
{ $ref: "#/components/parameters/group_sortOrder" },
{ $ref: "#/components/parameters/group_fields" },
+ { $ref: "#/components/parameters/group_filterKeys" },
],
responses: {
200: {
@@ -228803,7 +233601,6 @@
"Do not have permission to retrieve the requested groups.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of groups",
tags: ["Groups"],
},
@@ -228851,7 +233648,6 @@
description: "Do not have permission to create a group.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new group",
tags: ["Groups"],
},
@@ -228891,7 +233687,6 @@
"Do not have permission to synchronize groups.",
},
},
- security: [{ mtauth: [] }],
summary: "Synchronize groups",
tags: ["Groups"],
},
@@ -228954,7 +233749,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete a group",
tags: ["Groups"],
},
@@ -229006,7 +233800,6 @@
description: "Group not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve single group by its ID",
tags: ["Groups"],
},
@@ -229081,7 +233874,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update a group",
tags: ["Groups"],
},
@@ -229102,6 +233894,7 @@
{ $ref: "#/components/parameters/group_sortBy" },
{ $ref: "#/components/parameters/group_sortOrder" },
{ $ref: "#/components/parameters/group_fields" },
+ { $ref: "#/components/parameters/group_filterKeys" },
],
responses: {
200: {
@@ -229154,7 +233947,6 @@
description: "Group not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of members for specified group",
tags: ["Groups"],
},
@@ -229220,7 +234012,6 @@
description: "Group or Member not found.",
},
},
- security: [{ mtauth: [] }],
tags: ["Groups"],
},
},
@@ -229289,7 +234080,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
tags: ["Groups"],
},
get: {
@@ -229346,7 +234136,6 @@
description: "Group or Member not found.",
},
},
- security: [{ mtauth: [] }],
summary:
"Retrieve single member by its ID for specified group",
tags: ["Groups"],
@@ -229369,6 +234158,7 @@
{ $ref: "#/components/parameters/permission_sortOrder" },
{ $ref: "#/components/parameters/permission_fields" },
{ $ref: "#/components/parameters/permission_blogIds" },
+ { $ref: "#/components/parameters/permission_filterKeys" },
],
responses: {
200: {
@@ -229424,7 +234214,6 @@
description: "Group not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of permissions for group",
tags: ["Groups", "Permissions"],
},
@@ -229501,7 +234290,6 @@
description: "Site or Group not found",
},
},
- security: [{ mtauth: [] }],
summary: "Grant permissions to group",
tags: ["Groups", "Permissions"],
},
@@ -229578,7 +234366,6 @@
description: "Site or Group not found",
},
},
- security: [{ mtauth: [] }],
summary: "Revoke permissions from group",
tags: ["Groups", "Permissions"],
},
@@ -229594,6 +234381,7 @@
{ $ref: "#/components/parameters/permission_sortOrder" },
{ $ref: "#/components/parameters/permission_fields" },
{ $ref: "#/components/parameters/permission_blogIds" },
+ { $ref: "#/components/parameters/permission_filterKeys" },
],
responses: {
200: {
@@ -229649,7 +234437,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of permissions",
tags: ["Permissions"],
},
@@ -229707,7 +234494,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of plugins in the specified site",
tags: ["Plugins"],
},
@@ -229755,7 +234541,6 @@
description: "Site or Plugin not found",
},
},
- security: [{ mtauth: [] }],
summary: "Disable all plugins",
tags: ["Plugins"],
},
@@ -229803,7 +234588,6 @@
description: "Site or Plugin not found",
},
},
- security: [{ mtauth: [] }],
summary: "Enable all plugins",
tags: ["Plugins"],
},
@@ -229856,7 +234640,6 @@
description: "Site or Plugin not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve single plugin by its ID",
tags: ["Plugins"],
},
@@ -229912,7 +234695,6 @@
description: "Site or Plugin not found",
},
},
- security: [{ mtauth: [] }],
summary: "Disable a plugin",
tags: ["Plugins"],
},
@@ -229967,7 +234749,6 @@
description: "Site or Plugin not found",
},
},
- security: [{ mtauth: [] }],
summary: "Enable a plugin",
tags: ["Plugins"],
},
@@ -230052,7 +234833,6 @@
},
403: { description: "Do not have permission to publish." },
},
- security: [{ mtauth: [] }],
summary:
"Rebuild the static archives in relation to specified entries",
tags: ["Entries", "Publish"],
@@ -230180,7 +234960,6 @@
"Do not have permission to retrieve the list of roles.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of roles",
tags: ["Roles"],
},
@@ -230236,7 +235015,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new role",
tags: ["Roles"],
},
@@ -230299,7 +235077,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete an existing role",
tags: ["Roles"],
},
@@ -230351,7 +235128,6 @@
description: "Site or Role not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a single role by its ID",
tags: ["Roles"],
},
@@ -230426,7 +235202,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update an existing role",
tags: ["Roles"],
},
@@ -230448,6 +235223,7 @@
{ $ref: "#/components/parameters/permission_sortOrder" },
{ $ref: "#/components/parameters/permission_fields" },
{ $ref: "#/components/parameters/permission_blogIds" },
+ { $ref: "#/components/parameters/permission_filterKeys" },
],
responses: {
200: {
@@ -230503,7 +235279,6 @@
description: "Site or Role not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of permissions by role",
tags: ["Roles", "Permissions"],
},
@@ -230752,7 +235527,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new website",
tags: ["Sites"],
},
@@ -230815,7 +235589,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete an existing blog or website",
tags: ["Sites"],
},
@@ -230944,7 +235717,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new blog",
tags: ["Sites"],
},
@@ -231019,7 +235791,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update an existing blog or website",
tags: ["Sites"],
},
@@ -231043,6 +235814,7 @@
{ $ref: "#/components/parameters/asset_searchFields" },
{ $ref: "#/components/parameters/asset_limit" },
{ $ref: "#/components/parameters/asset_offset" },
+ { $ref: "#/components/parameters/asset_filterKeys" },
{
description:
"The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
@@ -231231,7 +236003,6 @@
description: "Conflict",
},
},
- security: [{ mtauth: [] }],
summary: "Upload a file",
tags: ["Assets"],
},
@@ -231300,7 +236071,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete an asset",
tags: ["Assets"],
},
@@ -231444,7 +236214,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update an asset",
tags: ["Assets"],
},
@@ -231485,6 +236254,7 @@
{ $ref: "#/components/parameters/entry_maxComments" },
{ $ref: "#/components/parameters/entry_maxTrackbacks" },
{ $ref: "#/components/parameters/entry_no_text_filter" },
+ { $ref: "#/components/parameters/entry_filterKeys" },
],
responses: {
200: {
@@ -231578,6 +236348,7 @@
{ $ref: "#/components/parameters/page_maxComments" },
{ $ref: "#/components/parameters/page_maxTrackbacks" },
{ $ref: "#/components/parameters/page_no_text_filter" },
+ { $ref: "#/components/parameters/page_filterKeys" },
],
responses: {
200: {
@@ -231787,7 +236558,6 @@
description: "Site not found",
},
},
- security: [{ mtauth: [] }],
summary: "Backup specified site",
tags: ["Sites", "BackupRestore"],
},
@@ -231955,7 +236725,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new category",
tags: ["Categories"],
},
@@ -232030,7 +236799,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Rearrange existing categories in a new order",
tags: ["Categories"],
},
@@ -232100,7 +236868,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete an existing category",
tags: ["Categories"],
},
@@ -232245,7 +237012,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update an existing category",
tags: ["Categories"],
},
@@ -232376,6 +237142,7 @@
{ $ref: "#/components/parameters/entry_maxComments" },
{ $ref: "#/components/parameters/entry_maxTrackbacks" },
{ $ref: "#/components/parameters/entry_no_text_filter" },
+ { $ref: "#/components/parameters/entry_filterKeys" },
],
responses: {
200: {
@@ -232776,6 +237543,10 @@
type: "string",
},
},
+ { $ref: "#/components/parameters/field_filterKeys" },
+ { $ref: "#/components/parameters/field_searchFields" },
+ { $ref: "#/components/parameters/field_sortBy" },
+ { $ref: "#/components/parameters/field_sortOrder" },
],
responses: {
200: {
@@ -232899,7 +237670,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete a comment",
tags: ["Comments"],
},
@@ -233045,7 +237815,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update a comment",
tags: ["Comments"],
},
@@ -233169,6 +237938,7 @@
name: "fields",
schema: { type: "string" },
},
+ { $ref: "#/components/parameters/entry_filterKeys" },
],
responses: {
200: {
@@ -233234,6 +238004,7 @@
required: 1,
schema: { type: "integer" },
},
+ { $ref: "#/components/parameters/entry_saveRevision" },
],
requestBody: {
content: {
@@ -233286,7 +238057,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new entry",
tags: ["Entries"],
},
@@ -233335,7 +238105,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Export entries",
tags: ["Entries"],
},
@@ -233426,7 +238195,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Import entries",
tags: ["Entries"],
},
@@ -233505,7 +238273,6 @@
description: "Site or Entry not found",
},
},
- security: [{ mtauth: [] }],
summary: "Make a preview for a entry",
tags: ["Entries"],
},
@@ -233574,7 +238341,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete an entry",
tags: ["Entries"],
},
@@ -233679,6 +238445,7 @@
required: 1,
schema: { type: "integer" },
},
+ { $ref: "#/components/parameters/entry_saveRevision" },
],
requestBody: {
content: {
@@ -233740,7 +238507,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update an entry",
tags: ["Entries"],
},
@@ -233788,6 +238554,8 @@
},
{ $ref: "#/components/parameters/asset_sortOrder" },
{ $ref: "#/components/parameters/asset_fields" },
+ { $ref: "#/components/parameters/asset_filterKeys" },
+ { $ref: "#/components/parameters/asset_searchFields" },
],
responses: {
200: {
@@ -233996,6 +238764,10 @@
name: "offset",
schema: { type: "integer" },
},
+ { $ref: "#/components/parameters/field_filterKeys" },
+ { $ref: "#/components/parameters/field_searchFields" },
+ { $ref: "#/components/parameters/field_sortBy" },
+ { $ref: "#/components/parameters/field_sortOrder" },
],
responses: {
200: {
@@ -234122,7 +238894,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new comment on an entry",
tags: ["Comments", "Entries"],
},
@@ -234210,7 +238981,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary: "Reply to specified comment",
tags: ["Comments", "Entries"],
},
@@ -234295,7 +239065,6 @@
description: "Site or Entry not found",
},
},
- security: [{ mtauth: [] }],
summary: "Make a preview for a entry with existing data",
tags: ["Entries"],
},
@@ -234353,7 +239122,6 @@
description: "Site or Theme not found",
},
},
- security: [{ mtauth: [] }],
summary: "Export site's theme",
tags: ["Themes"],
},
@@ -234374,6 +239142,7 @@
{ $ref: "#/components/parameters/field_sortBy" },
{ $ref: "#/components/parameters/field_sortOrder" },
{ $ref: "#/components/parameters/field_fields" },
+ { $ref: "#/components/parameters/field_filterKeys" },
],
responses: {
200: {
@@ -234426,7 +239195,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of fields in the specified site",
tags: ["CustomFields"],
},
@@ -234490,7 +239258,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new field",
tags: ["CustomFields"],
},
@@ -234559,7 +239326,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete a field",
tags: ["CustomFields"],
},
@@ -234617,7 +239383,6 @@
description: "Site or Field not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve single field by its ID",
tags: ["CustomFields"],
},
@@ -234698,7 +239463,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update a field",
tags: ["CustomFields"],
},
@@ -234857,7 +239621,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new folder.",
tags: ["Folders"],
},
@@ -234932,7 +239695,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Rearrange existing folders in a new order",
tags: ["Folders"],
},
@@ -235001,7 +239763,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete an existing folder",
tags: ["Folders"],
},
@@ -235145,7 +239906,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update an existing folder",
tags: ["Folders"],
},
@@ -235268,6 +240028,7 @@
{ $ref: "#/components/parameters/page_maxComments" },
{ $ref: "#/components/parameters/page_maxTrackbacks" },
{ $ref: "#/components/parameters/page_no_text_filter" },
+ { $ref: "#/components/parameters/page_filterKeys" },
],
responses: {
200: {
@@ -235588,7 +240349,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary:
"Retrieve a list of formatted_texts in the specified site",
tags: ["FormattedText"],
@@ -235656,7 +240416,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new formatted_text",
tags: ["FormattedText"],
},
@@ -235728,7 +240487,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete a formatted_text",
tags: ["FormattedText"],
},
@@ -235788,7 +240546,6 @@
description: "Site or FormattedText not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve single formatted_text by its ID",
tags: ["FormattedText"],
},
@@ -235872,7 +240629,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update a formatted_text",
tags: ["FormattedText"],
},
@@ -235938,7 +240694,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Reset logs",
tags: ["Logs"],
},
@@ -235956,6 +240711,7 @@
{ $ref: "#/components/parameters/log_searchFields" },
{ $ref: "#/components/parameters/log_limit" },
{ $ref: "#/components/parameters/log_offset" },
+ { $ref: "#/components/parameters/log_filterKeys" },
{
description:
"- id\n- created_on\n- blog_id\n- author_id\n- level\n- class\n\n**Default**: created_on\n",
@@ -236050,7 +240806,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of logs in the specified site",
tags: ["Logs"],
},
@@ -236112,7 +240867,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new log",
tags: ["Logs"],
},
@@ -236165,7 +240919,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Export logs",
tags: ["Logs"],
},
@@ -236234,7 +240987,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete an existing log",
tags: ["Logs"],
},
@@ -236292,7 +241044,6 @@
description: "Site or Log not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a single log by its ID",
tags: ["Logs"],
},
@@ -236371,7 +241122,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update an existing log",
tags: ["Logs"],
},
@@ -236406,6 +241156,7 @@
{ $ref: "#/components/parameters/page_maxComments" },
{ $ref: "#/components/parameters/page_maxTrackbacks" },
{ $ref: "#/components/parameters/page_no_text_filter" },
+ { $ref: "#/components/parameters/page_filterKeys" },
],
responses: {
200: {
@@ -236471,6 +241222,7 @@
required: 1,
schema: { type: "integer" },
},
+ { $ref: "#/components/parameters/page_saveRevision" },
],
requestBody: {
content: {
@@ -236523,7 +241275,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new page",
tags: ["Pages"],
},
@@ -236602,7 +241353,6 @@
description: "Site or Page not found",
},
},
- security: [{ mtauth: [] }],
summary: "Make a preview for a page",
tags: ["Pages"],
},
@@ -236671,7 +241421,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete an existing page",
tags: ["Pages"],
},
@@ -236756,6 +241505,7 @@
required: 1,
schema: { type: "integer" },
},
+ { $ref: "#/components/parameters/page_saveRevision" },
],
requestBody: {
content: {
@@ -236817,7 +241567,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update an existing page",
tags: ["Pages"],
},
@@ -236845,6 +241594,8 @@
},
{ $ref: "#/components/parameters/asset_limit" },
{ $ref: "#/components/parameters/asset_offset" },
+ { $ref: "#/components/parameters/asset_filterKeys" },
+ { $ref: "#/components/parameters/asset_searchFields" },
{
description:
"The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
@@ -236954,6 +241705,10 @@
name: "offset",
schema: { type: "integer" },
},
+ { $ref: "#/components/parameters/field_filterKeys" },
+ { $ref: "#/components/parameters/field_searchFields" },
+ { $ref: "#/components/parameters/field_sortBy" },
+ { $ref: "#/components/parameters/field_sortOrder" },
],
responses: {
200: {
@@ -237080,7 +241835,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new comment on a page",
tags: ["Comments", "Pages"],
},
@@ -237168,7 +241922,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary: "Reply to specified comment",
tags: ["Comments", "Pages"],
},
@@ -237253,7 +242006,6 @@
description: "Site or Page not found",
},
},
- security: [{ mtauth: [] }],
summary: "Make a preview for a page with existing data",
tags: ["Pages"],
},
@@ -237329,7 +242081,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of permissions for site",
tags: ["Sites", "Permissions"],
},
@@ -237406,7 +242157,6 @@
description: "Site or Role or User not found",
},
},
- security: [{ mtauth: [] }],
summary: "Grant permissions to site",
tags: ["Sites", "Permissions"],
},
@@ -237483,7 +242233,6 @@
description: "Site or Role or User not found",
},
},
- security: [{ mtauth: [] }],
summary: "Revoke permissions from site",
tags: ["Sites", "Permissions"],
},
@@ -237552,7 +242301,6 @@
description: "Site not found",
},
},
- security: [{ mtauth: [] }],
summary: "Reset all templates in the site",
tags: ["Templates"],
},
@@ -237570,7 +242318,7 @@
},
{
description:
- 'This is an required parameter. Start date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. Start date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "startDate",
required: 1,
@@ -237578,7 +242326,7 @@
},
{
description:
- 'This is an required parameter. End date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. End date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "endDate",
required: 1,
@@ -237607,7 +242355,7 @@
},
{
description:
- "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
in: "query",
name: "uniquePath",
schema: { enum: [0, 1], type: "integer" },
@@ -237673,7 +242421,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary:
"Retrieve pageviews count for each date from provider (e.g. Google Analytics)",
tags: ["Statistics"],
@@ -237692,7 +242439,7 @@
},
{
description:
- 'This is an required parameter. Start date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. Start date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "startDate",
required: 1,
@@ -237700,7 +242447,7 @@
},
{
description:
- 'This is an required parameter. End date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. End date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "endDate",
required: 1,
@@ -237788,7 +242535,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary:
"Retrieve visits count for each date from provider (e.g. Google Analytics)",
tags: ["Statistics"],
@@ -237807,7 +242553,7 @@
},
{
description:
- 'This is an required parameter. Start date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. Start date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "startDate",
required: 1,
@@ -237815,7 +242561,7 @@
},
{
description:
- 'This is an required parameter. End date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. End date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "endDate",
required: 1,
@@ -237844,7 +242590,7 @@
},
{
description:
- "This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
+ "This is an optional parameter. If true is given, the MT can return total pageviews for each unique path. However, that data does not contain page title because of its spec. (Sometimes, Google Analytics will return another pageviews by same path.)",
in: "query",
name: "uniquePath",
schema: { enum: [0, 1], type: "integer" },
@@ -237910,7 +242656,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary:
"Retrieve pageviews count for each path from provider (e.g. Google Analytics)",
tags: ["Statistics"],
@@ -237929,7 +242674,7 @@
},
{
description:
- 'This is an required parameter. Start date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. Start date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "startDate",
required: 1,
@@ -237937,7 +242682,7 @@
},
{
description:
- 'This is an required parameter. End date of data. The format is "YYYY-MM-DD".',
+ 'This is a required parameter. End date of data. The format is "YYYY-MM-DD".',
in: "query",
name: "endDate",
required: 1,
@@ -238025,7 +242770,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary:
"Retrieve visits count for each path from provider (e.g. Google Analytics)",
tags: ["Statistics"],
@@ -238080,7 +242824,6 @@
description: "Not Found",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a current effective provider",
tags: ["Statistics"],
},
@@ -238222,7 +242965,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete an existing tag",
tags: ["Tags"],
},
@@ -238358,7 +243100,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update an existing tag",
tags: ["Tags"],
},
@@ -238386,6 +243127,8 @@
},
{ $ref: "#/components/parameters/asset_limit" },
{ $ref: "#/components/parameters/asset_offset" },
+ { $ref: "#/components/parameters/asset_filterKeys" },
+ { $ref: "#/components/parameters/asset_searchFields" },
{
description:
"The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.",
@@ -238494,6 +243237,7 @@
{ $ref: "#/components/parameters/entry_maxComments" },
{ $ref: "#/components/parameters/entry_maxTrackbacks" },
{ $ref: "#/components/parameters/entry_no_text_filter" },
+ { $ref: "#/components/parameters/entry_filterKeys" },
],
responses: {
200: {
@@ -238587,6 +243331,7 @@
{ $ref: "#/components/parameters/page_maxComments" },
{ $ref: "#/components/parameters/page_maxTrackbacks" },
{ $ref: "#/components/parameters/page_no_text_filter" },
+ { $ref: "#/components/parameters/page_filterKeys" },
],
responses: {
200: {
@@ -238659,6 +243404,7 @@
{ $ref: "#/components/parameters/template_searchFields" },
{ $ref: "#/components/parameters/template_limit" },
{ $ref: "#/components/parameters/template_offset" },
+ { $ref: "#/components/parameters/template_filterKeys" },
{
description:
"#### id\n\nSort by the ID of each template.\n\n#### name\n\nSort by the name of each template.\n\n#### created_on\n\nSort by the created time of each template.\n\n#### modified_on\n\nSort by the modified time of each template.\n\n#### created_by\n\nSort by the ID of user who created each template.\n\n#### modified_by\n\nSort by the ID of user who modified each template.\n\n#### type\n\nSort by the type of each template.\n\n**Default**: name\n",
@@ -238743,7 +243489,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of templates in the specified site",
tags: ["Templates"],
},
@@ -238757,6 +243502,7 @@
required: 1,
schema: { type: "integer" },
},
+ { $ref: "#/components/parameters/template_saveRevision" },
],
requestBody: {
content: {
@@ -238810,7 +243556,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new template",
tags: ["Templates"],
},
@@ -238890,7 +243635,6 @@
description: "Site not found",
},
},
- security: [{ mtauth: [] }],
summary: "Make a preview for a template",
tags: ["Templates"],
},
@@ -238960,7 +243704,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete a template",
tags: ["Templates"],
},
@@ -239020,7 +243763,6 @@
description: "Site or Template not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve single template by its ID",
tags: ["Templates"],
},
@@ -239040,6 +243782,7 @@
required: 1,
schema: { type: "integer" },
},
+ { $ref: "#/components/parameters/template_saveRevision" },
],
requestBody: {
content: {
@@ -239102,7 +243845,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update a template",
tags: ["Templates"],
},
@@ -239166,7 +243908,6 @@
description: "Site or Template not found",
},
},
- security: [{ mtauth: [] }],
summary: "Make a clone of a template",
tags: ["Templates"],
},
@@ -239252,7 +243993,6 @@
description: "Site or Template not found",
},
},
- security: [{ mtauth: [] }],
summary: "Make a preview for a template with existing data",
tags: ["Templates"],
},
@@ -239316,7 +244056,6 @@
description: "Site or Template not found",
},
},
- security: [{ mtauth: [] }],
summary: "Publish a template",
tags: ["Templates"],
},
@@ -239386,7 +244125,6 @@
description: "Site or Template not found",
},
},
- security: [{ mtauth: [] }],
summary:
"Reset template text to theme default or tempalte_set default",
tags: ["Templates"],
@@ -239418,6 +244156,7 @@
{ $ref: "#/components/parameters/templatemap_fields" },
{ $ref: "#/components/parameters/templatemap_includeIds" },
{ $ref: "#/components/parameters/templatemap_excludeIds" },
+ { $ref: "#/components/parameters/templatemap_filterKeys" },
],
responses: {
200: {
@@ -239474,7 +244213,6 @@
description: "Site or Template not found.",
},
},
- security: [{ mtauth: [] }],
summary:
"Retrieve a list of templatemaps in the specified site",
tags: ["Templates", "TemplateMaps"],
@@ -239546,7 +244284,6 @@
description: "Site or Template not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new templatemap",
tags: ["Templates", "TemplateMaps"],
},
@@ -239634,7 +244371,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete an existing templatemap",
tags: ["Templates", "TemplateMaps"],
},
@@ -239706,7 +244442,6 @@
"Site or Template or TemplateMap not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a single templatemap by its ID",
tags: ["Templates", "TemplateMaps"],
},
@@ -239805,7 +244540,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update an existing templatemap",
tags: ["Templates", "TemplateMaps"],
},
@@ -239873,7 +244607,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of themes for site",
tags: ["Themes"],
},
@@ -239934,7 +244667,6 @@
description: "Site or Theme not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a single theme by its ID for site",
tags: ["Themes"],
},
@@ -239998,7 +244730,6 @@
description: "Site or Theme not found",
},
},
- security: [{ mtauth: [] }],
summary: "Apply a theme to site",
tags: ["Themes"],
},
@@ -240075,7 +244806,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of widgets in the specified site",
tags: ["Widgets"],
},
@@ -240139,7 +244869,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new widget",
tags: ["Widgets"],
},
@@ -240208,7 +244937,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete a widget",
tags: ["Widgets"],
},
@@ -240266,7 +244994,6 @@
description: "Site or Widget not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a single widget by its ID",
tags: ["Widgets"],
},
@@ -240347,7 +245074,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update a widget",
tags: ["Widgets"],
},
@@ -240408,7 +245134,6 @@
description: "Site or Widget not found",
},
},
- security: [{ mtauth: [] }],
summary: "Make a clone of a widget",
tags: ["Widgets"],
},
@@ -240476,7 +245201,6 @@
description: "Site or Widget not found",
},
},
- security: [{ mtauth: [] }],
summary: "Reset widget text to default",
tags: ["Widgets"],
},
@@ -240553,7 +245277,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary:
"Retrieve a list of widgetsets in the specified site",
tags: ["WidgetSets"],
@@ -240619,7 +245342,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new widgetset",
tags: ["WidgetSets"],
},
@@ -240689,7 +245411,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete an existing widgetset",
tags: ["WidgetSets"],
},
@@ -240747,7 +245468,6 @@
description: "Site or WidgetSet not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a single widgetset by its ID",
tags: ["WidgetSets"],
},
@@ -240829,7 +245549,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update an existing widgetset",
tags: ["WidgetSets"],
},
@@ -240912,7 +245631,6 @@
description: "Site or WidgetSet not found.",
},
},
- security: [{ mtauth: [] }],
summary:
"Retrieve a list of widgets in the specified widgetset",
tags: ["Widgets", "WidgetSets"],
@@ -240986,7 +245704,6 @@
description: "Site or Widget not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a single widget by widgetset ID",
tags: ["Widgets", "WidgetSets"],
},
@@ -241046,7 +245763,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of themes",
tags: ["Themes"],
},
@@ -241110,7 +245826,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Uninstall a specified theme from the MT",
tags: ["Themes"],
},
@@ -241163,7 +245878,6 @@
description: "Site or Theme not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a single theme by its ID",
tags: ["Themes"],
},
@@ -241216,7 +245930,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Invalidate current session. This is like logout",
tags: ["Authentication"],
},
@@ -241305,6 +246018,7 @@
{ $ref: "#/components/parameters/user_searchFields" },
{ $ref: "#/components/parameters/user_limit" },
{ $ref: "#/components/parameters/user_offset" },
+ { $ref: "#/components/parameters/user_filterKeys" },
{
description:
"The field name for sort. You can specify one of following values\n- id\n- name\n\n**Default**: name\n",
@@ -241449,7 +246163,6 @@
description: "Site not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new user",
tags: ["Users"],
},
@@ -241481,7 +246194,6 @@
description: "Do not have permission to export users.",
},
},
- security: [{ mtauth: [] }],
summary: "Export users",
tags: ["Users"],
},
@@ -241539,7 +246251,6 @@
description: "Do not have permission to import users.",
},
},
- security: [{ mtauth: [] }],
summary: "Import users",
tags: ["Users"],
},
@@ -241579,7 +246290,6 @@
"Do not have permission to synchronize users.",
},
},
- security: [{ mtauth: [] }],
summary: "Synchronize users",
tags: ["Users"],
},
@@ -241642,7 +246352,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete user",
tags: ["Users"],
},
@@ -241783,7 +246492,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update user data",
tags: ["Users"],
},
@@ -241804,6 +246512,7 @@
{ $ref: "#/components/parameters/group_sortBy" },
{ $ref: "#/components/parameters/group_sortOrder" },
{ $ref: "#/components/parameters/group_fields" },
+ { $ref: "#/components/parameters/group_filterKeys" },
],
responses: {
200: {
@@ -241856,7 +246565,6 @@
description: "User not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of groups",
tags: ["Users", "Groups"],
},
@@ -241878,6 +246586,7 @@
{ $ref: "#/components/parameters/permission_sortOrder" },
{ $ref: "#/components/parameters/permission_fields" },
{ $ref: "#/components/parameters/permission_blogIds" },
+ { $ref: "#/components/parameters/permission_filterKeys" },
],
responses: {
200: {
@@ -241933,7 +246642,6 @@
description: "Site or User not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of permissions for user",
tags: ["Users", "Permissions"],
},
@@ -242010,7 +246718,6 @@
description: "Site or Role or User not found",
},
},
- security: [{ mtauth: [] }],
summary: "Grant permissions to user",
tags: ["Users", "Permissions"],
},
@@ -242087,7 +246794,6 @@
description: "Site or Role or User not found",
},
},
- security: [{ mtauth: [] }],
summary: "Revoke permissions from user",
tags: ["Users", "Permissions"],
},
@@ -242148,7 +246854,6 @@
description: "Site or User not found",
},
},
- security: [{ mtauth: [] }],
summary:
"Send the link for password recovery to specified user by email",
tags: ["Users"],
@@ -242329,7 +247034,6 @@
description: "Site or User not found",
},
},
- security: [{ mtauth: [] }],
summary: "Unlock user account",
tags: ["Users"],
},
@@ -242375,6 +247079,7 @@
},
},
},
+ security: [{ mtauth: [] }],
servers: [{ url: "https://example.com/mt/mt-data-api.cgi/v2" }],
tags: [
{ name: "Authentication" },
diff --git a/docs/v3.html b/docs/v3.html
index 03fb4bb..12b94b2 100644
--- a/docs/v3.html
+++ b/docs/v3.html
@@ -7887,7 +7887,7 @@
Movable Type Data API
- (8.6.0)
+ (8.7.0)
Download OpenAPI specification:
@@ -9111,6 +9111,31 @@
>Retrieve assets in the specified site
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -9315,6 +9340,49 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "class"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : class
+
+
+
+
+
>Retrieve single asset by its ID
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -14479,6 +14572,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -15147,6 +15265,49 @@ Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -18280,6 +18466,49 @@ Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -20706,6 +20960,31 @@
>Retrieve assets that related with specified entry
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -21068,6 +21347,92 @@ ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "class"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : class
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "label"
+
+
+
+
+ The comma separated field name list to search.
+
+
Default : label
+
+
+
+
+
>Retrieve assets that related with specified page
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -22333,6 +22723,92 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "class"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : class
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "label"
+
+
+
+
+ The comma separated field name list to search.
+
+
Default : label
+
+
+
+
+
>Retrieve assets that related with specified tag
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -23799,6 +24300,92 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "class"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : class
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "label"
+
+
+
+
+ The comma separated field name list to search.
+
+
Default : label
+
+
+
+
+
Notes
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
header
@@ -25546,6 +26158,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
Request Body schema:
Return authorization(login) form as HTML.
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
query
@@ -26707,6 +27369,31 @@
MTAuth sessionId={retrieved sessionId}
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
header
@@ -27463,6 +28150,31 @@
>Retrieve categories in the specified site
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -31200,6 +31912,31 @@
>Retrieve single category by its ID
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -32788,6 +33525,31 @@
>Retrieve child categories from the specified category
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -33806,6 +34568,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -34474,6 +35261,49 @@ Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
>Retrieve parent categories from the specified category
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -37894,6 +38749,31 @@
>Retrieve siblings categories from the specified category
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -39379,6 +40259,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -40917,6 +41822,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -41243,6 +42173,194 @@ Spam
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "systemObject,type"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default : systemObject,type
+
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name,basename,description,tag"
+
+
+
+
+ The comma separated field name list to search.
+
+
+ Default :
+ name,basename,description,tag
+
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name"
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "ascend"
+
+
+
+ Enum:
+ "descend"
+ "ascend"
+
+
+
+
descend
+
Return fields in descending order.
+
ascend
+
Return fields in ascending order.
+
Default : ascend
+
+
+
+
+
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -44804,6 +45947,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -44951,6 +46119,194 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "systemObject,type"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default : systemObject,type
+
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name,basename,description,tag"
+
+
+
+
+ The comma separated field name list to search.
+
+
+ Default :
+ name,basename,description,tag
+
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name"
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "ascend"
+
+
+
+ Enum:
+ "descend"
+ "ascend"
+
+
+
+
descend
+
Return fields in descending order.
+
ascend
+
Return fields in ascending order.
+
Default : ascend
+
+
+
+
+
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -47837,6 +49218,194 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "systemObject,type"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default : systemObject,type
+
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name,basename,description,tag"
+
+
+
+
+ The comma separated field name list to search.
+
+
+ Default :
+ name,basename,description,tag
+
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name"
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "ascend"
+
+
+
+ Enum:
+ "descend"
+ "ascend"
+
+
+
+
descend
+
Return fields in descending order.
+
ascend
+
Return fields in ascending order.
+
Default : ascend
+
+
+
+
+
>Retrieve OpenAPI schema
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
Responses
@@ -50825,6 +52419,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
Responses
@@ -51453,6 +53072,51 @@
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "systemObject,type"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default : systemObject,type
+
+
+
+
+
+
Retrieve a list of endpoints.
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
query
@@ -55856,6 +57545,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -56524,6 +58238,49 @@ Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -59658,6 +61440,49 @@ Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -62674,6 +64524,49 @@ ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
+
+
+ query
+ Parameters
+
+
+
+
+
+ saveRevision
+
+
+
+
+ integer
+
+
+
+ Enum:
+ 0
+ 1
+
+
+
+
Save a revision or not
+
+
+
+
+
+
+
+
Request Body schema:
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -73342,6 +75312,58 @@
+
+
+ query
+ Parameters
+
+
+
+
+
+ saveRevision
+
+
+
+
+ integer
+
+
+
+ Enum:
+ 0
+ 1
+
+
+
+
Save a revision or not
+
+
+
+
+
+
+
+
Request Body schema:
>Retrieve assets that related with specified entry
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -75827,6 +77874,92 @@ ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "class"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : class
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "label"
+
+
+
+
+ The comma separated field name list to search.
+
+
Default : label
+
+
+
+
+
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -77091,6 +79249,194 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "systemObject,type"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default : systemObject,type
+
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name,basename,description,tag"
+
+
+
+
+ The comma separated field name list to search.
+
+
+ Default :
+ name,basename,description,tag
+
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name"
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "ascend"
+
+
+
+ Enum:
+ "descend"
+ "ascend"
+
+
+
+
descend
+
Return fields in descending order.
+
ascend
+
Return fields in ascending order.
+
Default : ascend
+
+
+
+
+
Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -81076,6 +83447,49 @@ Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -87283,6 +89722,31 @@
>Retrieve single folder by its ID
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -88907,6 +91371,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -89897,6 +92386,31 @@ Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -90565,6 +93079,49 @@ Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -93409,6 +95991,31 @@
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -99028,6 +101635,49 @@ ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "level"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : level
+
+
+
+
+
Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -114932,6 +117779,49 @@ Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -117492,6 +120407,49 @@ Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -120021,6 +123004,49 @@ Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
+
+
+ query
+ Parameters
+
+
+
+
+
+ saveRevision
+
+
+
+
+ integer
+
+
+
+ Enum:
+ 0
+ 1
+
+
+
+
Save a revision or not
+
+
+
+
+
+
+
+
Request Body schema:
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -127392,6 +130495,58 @@
+
+
+ query
+ Parameters
+
+
+
+
+
+ saveRevision
+
+
+
+
+ integer
+
+
+
+ Enum:
+ 0
+ 1
+
+
+
+
Save a revision or not
+
+
+
+
+
+
+
+
Request Body schema:
>Retrieve assets that related with specified page
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -129131,6 +132311,92 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "class"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : class
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "label"
+
+
+
+
+ The comma separated field name list to search.
+
+
Default : label
+
+
+
+
+
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -130596,6 +133887,194 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "systemObject,type"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default : systemObject,type
+
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name,basename,description,tag"
+
+
+
+
+ The comma separated field name list to search.
+
+
+ Default :
+ name,basename,description,tag
+
+
+
+
+
+
+
+
+ sortBy
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "name"
+
+
+
+
+
+
+
+ sortOrder
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "ascend"
+
+
+
+ Enum:
+ "descend"
+ "ascend"
+
+
+
+
descend
+
Return fields in descending order.
+
ascend
+
Return fields in ascending order.
+
Default : ascend
+
+
+
+
+
Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -134579,6 +138083,49 @@ Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
>Searching entries
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
query
@@ -155243,6 +159030,31 @@
>Retrieve sites
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
query
@@ -160833,6 +164645,31 @@
>Retrieve a single blog by its ID
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -166039,6 +169876,31 @@
>Retrieve sites by parent ID
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -170587,6 +174449,31 @@
Retrieve a list of blogs by user.
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -173159,12 +177046,12 @@
- This is an required parameter. Start date of
+ This is a required parameter. Start date of
data. The format is "YYYY-MM-DD".
@@ -173198,12 +177085,12 @@
- This is an required parameter. End date of
+ This is a required parameter. End date of
data. The format is "YYYY-MM-DD".
@@ -173346,15 +177233,15 @@
This is an optional parameter. If true is
given, the MT can return total pageviews for
- each uniqueness paths. However, that data does
- not contain page title because its spec.
+ each unique path. However, that data does not
+ contain page title because of its spec.
(Sometimes, Google Analytics will return
another pageviews by same path.)
@@ -173865,12 +177752,12 @@
- This is an required parameter. Start date of
+ This is a required parameter. Start date of
data. The format is "YYYY-MM-DD".
@@ -173904,12 +177791,12 @@
- This is an required parameter. End date of
+ This is a required parameter. End date of
data. The format is "YYYY-MM-DD".
@@ -174522,12 +178409,12 @@
- This is an required parameter. Start date of
+ This is a required parameter. Start date of
data. The format is "YYYY-MM-DD".
@@ -174561,12 +178448,12 @@
- This is an required parameter. End date of
+ This is a required parameter. End date of
data. The format is "YYYY-MM-DD".
@@ -174709,15 +178596,15 @@
This is an optional parameter. If true is
given, the MT can return total pageviews for
- each uniqueness paths. However, that data does
- not contain page title because its spec.
+ each unique path. However, that data does not
+ contain page title because of its spec.
(Sometimes, Google Analytics will return
another pageviews by same path.)
@@ -175373,12 +179260,12 @@
- This is an required parameter. Start date of
+ This is a required parameter. Start date of
data. The format is "YYYY-MM-DD".
@@ -175412,12 +179299,12 @@
- This is an required parameter. End date of
+ This is a required parameter. End date of
data. The format is "YYYY-MM-DD".
@@ -176433,6 +180320,31 @@
>Retrieve a list of tags that related with specific site
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -177860,6 +181772,31 @@
>Retrieve a single tag by its ID
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -178933,6 +182870,31 @@
>Retrieve assets that related with specified tag
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -179094,6 +183056,92 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "class"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : class
+
+
+
+
+
+
+
+ searchFields
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "label"
+
+
+
+
+ The comma separated field name list to search.
+
+
Default : label
+
+
+
+
+
Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -181099,6 +185172,49 @@ Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -184232,6 +188373,49 @@ Unpublish
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "archiveType,buildType,isPreferred"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default :
+ archiveType,buildType,isPreferred
+
+
+
+
+
+
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "type"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : type
+
+
+
+
+
+
+
+ query
+ Parameters
+
+
+
+
+
+ saveRevision
+
+
+
+
+ integer
+
+
+
+ Enum:
+ 0
+ 1
+
+
+
+
Save a revision or not
+
+
+
+
+
+
+
+
Request Body schema:
+
+
+ query
+ Parameters
+
+
+
+
+
+ saveRevision
+
+
+
+
+ integer
+
+
+
+ Enum:
+ 0
+ 1
+
+
+
+
Save a revision or not
+
+
+
+
+
+
+
+
Request Body schema:
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "archiveType,buildType,isPreferred"
+
+
+
+
+ The comma separated field name list to filter.
+
+
+ Default :
+ archiveType,buildType,isPreferred
+
+
+
+
+
+
Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
Request Body schema:
Permissions
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
query
@@ -204661,6 +209134,49 @@
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status,lockout"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status,lockout
+
+
+
+
+
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -210657,6 +215198,49 @@ ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "status"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : status
+
+
+
+
+
ascend
+
+
+ filterKeys
+
+
+
+
+ string
+
+
+
+ Default:
+
+ "blogIds"
+
+
+
+
+ The comma separated field name list to filter.
+
+
Default : blogIds
+
+
+
+
+
Retrieve a list of blogs by user.
+
+
+
+ Authorizations:
+
+
+
+
+
+
+ mtauth
+
+
path
@@ -233534,6 +238186,13 @@
name: "fields",
schema: { type: "string" },
},
+ asset_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: class",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "class", type: "string" },
+ },
asset_includeIds: {
description:
"The comma separated ID list of assets to include to result.",
@@ -233619,6 +238278,12 @@
name: "fields",
schema: { type: "string" },
},
+ category_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
category_includeIds: {
description:
"The comma separated ID list of categories to include to result.",
@@ -233704,6 +238369,13 @@
name: "fields",
schema: { type: "string" },
},
+ comment_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: status",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "status", type: "string" },
+ },
comment_includeIds: {
description:
"The comma separated ID list of comments to include to result.",
@@ -233789,6 +238461,13 @@
name: "fields",
schema: { type: "string" },
},
+ entry_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: status",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "status", type: "string" },
+ },
entry_includeIds: {
description:
"The comma separated ID list of entries to include to result.",
@@ -233830,6 +238509,12 @@
name: "offset",
schema: { default: 0, type: "integer" },
},
+ entry_saveRevision: {
+ description: "Save a revision or not",
+ in: "query",
+ name: "saveRevision",
+ schema: { enum: [0, 1], type: "integer" },
+ },
entry_search: {
description: "Search query.",
in: "query",
@@ -233920,6 +238605,13 @@
name: "fields",
schema: { type: "string" },
},
+ field_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: systemObject,type",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "systemObject,type", type: "string" },
+ },
field_includeIds: {
description:
"The comma separated ID list of fields to include to result.",
@@ -234008,6 +238700,12 @@
name: "fields",
schema: { type: "string" },
},
+ folder_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
folder_includeIds: {
description:
"The comma separated ID list of folders to include to result.",
@@ -234093,6 +238791,12 @@
name: "fields",
schema: { type: "string" },
},
+ formatted_text_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
formatted_text_includeIds: {
description:
"The comma separated ID list of formatted_texts to include to result.",
@@ -234178,6 +238882,13 @@
name: "fields",
schema: { type: "string" },
},
+ group_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: status",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "status", type: "string" },
+ },
group_includeIds: {
description:
"The comma separated ID list of groups to include to result.",
@@ -234266,6 +238977,13 @@
name: "fields",
schema: { type: "string" },
},
+ log_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: level",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "level", type: "string" },
+ },
log_includeIds: {
description:
"The comma separated ID list of logs to include to result.",
@@ -234351,6 +239069,13 @@
name: "fields",
schema: { type: "string" },
},
+ page_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: status",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "status", type: "string" },
+ },
page_includeIds: {
description:
"The comma separated ID list of pages to include to result.",
@@ -234392,6 +239117,12 @@
name: "offset",
schema: { default: 0, type: "integer" },
},
+ page_saveRevision: {
+ description: "Save a revision or not",
+ in: "query",
+ name: "saveRevision",
+ schema: { enum: [0, 1], type: "integer" },
+ },
page_search: {
description: "Search query.",
in: "query",
@@ -234489,6 +239220,13 @@
name: "fields",
schema: { type: "string" },
},
+ permission_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: blogIds",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "blogIds", type: "string" },
+ },
permission_includeIds: {
description:
"The comma separated ID list of permissions to include to result.",
@@ -234584,6 +239322,12 @@
name: "fields",
schema: { type: "string" },
},
+ role_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
role_includeIds: {
description:
"The comma separated ID list of roles to include to result.",
@@ -234680,6 +239424,12 @@
name: "fields",
schema: { type: "string" },
},
+ site_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
site_includeIds: {
description:
"The comma separated ID list of sites to include to result.",
@@ -234766,6 +239516,12 @@
name: "fields",
schema: { type: "string" },
},
+ tag_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
tag_includeIds: {
description:
"The comma separated ID list of tags to include to result.",
@@ -234851,6 +239607,13 @@
name: "fields",
schema: { type: "string" },
},
+ template_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: type",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "type", type: "string" },
+ },
template_includeIds: {
description:
"The comma separated ID list of templates to include to result.",
@@ -234871,6 +239634,12 @@
name: "offset",
schema: { default: 0, type: "integer" },
},
+ template_saveRevision: {
+ description: "Save a revision or not",
+ in: "query",
+ name: "saveRevision",
+ schema: { enum: [0, 1], type: "integer" },
+ },
template_search: {
description: "Search query.",
in: "query",
@@ -234936,6 +239705,16 @@
name: "fields",
schema: { type: "string" },
},
+ templatemap_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: archiveType,buildType,isPreferred",
+ in: "query",
+ name: "filterKeys",
+ schema: {
+ default: "archiveType,buildType,isPreferred",
+ type: "string",
+ },
+ },
templatemap_includeIds: {
description:
"The comma separated ID list of templatemaps to include to result.",
@@ -235020,6 +239799,13 @@
name: "fields",
schema: { type: "string" },
},
+ user_filterKeys: {
+ description:
+ "The comma separated field name list to filter.\n\n**Default**: status,lockout",
+ in: "query",
+ name: "filterKeys",
+ schema: { default: "status,lockout", type: "string" },
+ },
user_includeIds: {
description:
"The comma separated ID list of users to include to result.",
@@ -235108,6 +239894,12 @@
name: "fields",
schema: { type: "string" },
},
+ widget_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
widget_includeIds: {
description:
"The comma separated ID list of widgets to include to result.",
@@ -235193,6 +239985,12 @@
name: "fields",
schema: { type: "string" },
},
+ widgetset_filterKeys: {
+ description: "The comma separated field name list to filter.",
+ in: "query",
+ name: "filterKeys",
+ schema: { type: "string" },
+ },
widgetset_includeIds: {
description:
"The comma separated ID list of widgetsets to include to result.",
@@ -236834,7 +241632,7 @@
description: "Find out more about Movable Type Data API",
url: "https://www.movabletype.jp/developers/data-api/",
},
- info: { title: "Movable Type Data API", version: "8.6.0" },
+ info: { title: "Movable Type Data API", version: "8.7.0" },
openapi: "3.0.0",
paths: {
"/": {
@@ -236996,7 +241794,6 @@
"Upload file size is larger than CGIMaxUpload.",
},
},
- security: [{ mtauth: [] }],
summary: "Upload a file",
tags: ["Assets"],
},
@@ -237292,6 +242089,7 @@
{ $ref: "#/components/parameters/group_sortBy" },
{ $ref: "#/components/parameters/group_sortOrder" },
{ $ref: "#/components/parameters/group_fields" },
+ { $ref: "#/components/parameters/group_filterKeys" },
{ $ref: "#/components/parameters/group_dateField" },
{ $ref: "#/components/parameters/group_dateFrom" },
{ $ref: "#/components/parameters/group_dateTo" },
@@ -237339,7 +242137,6 @@
"Do not have permission to retrieve the requested groups.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve a list of groups",
tags: ["Groups"],
},
@@ -237387,7 +242184,6 @@
description: "Do not have permission to create a group.",
},
},
- security: [{ mtauth: [] }],
summary: "Create a new group",
tags: ["Groups"],
},
@@ -237427,7 +242223,6 @@
"Do not have permission to synchronize groups.",
},
},
- security: [{ mtauth: [] }],
summary: "Synchronize groups",
tags: ["Groups"],
},
@@ -237490,7 +242285,6 @@
"Request method is not DELETE or POST with __method=DELETE",
},
},
- security: [{ mtauth: [] }],
summary: "Delete a group",
tags: ["Groups"],
},
@@ -237542,7 +242336,6 @@
description: "Group not found.",
},
},
- security: [{ mtauth: [] }],
summary: "Retrieve single group by its ID",
tags: ["Groups"],
},
@@ -237617,7 +242410,6 @@
"Request method is not PUT or POST with __method=PUT",
},
},
- security: [{ mtauth: [] }],
summary: "Update a group",
tags: ["Groups"],
},
@@ -237638,6 +242430,7 @@
{ $ref: "#/components/parameters/group_sortBy" },
{ $ref: "#/components/parameters/group_sortOrder" },
{ $ref: "#/components/parameters/group_fields" },
+ { $ref: "#/components/parameters/group_filterKeys" },
{ $ref: "#/components/parameters/user_dateField" },
{ $ref: "#/components/parameters/user_dateFrom" },
{ $ref: "#/components/parameters/user_dateTo" },
@@ -237693,7 +242486,6 @@