{
"schemes": [
"https"
],
"swagger": "2.0",
"info": {
"description": "Edit Analytics provides data about the number of edits and edited pages on Wikimedia projects.\nData provided by this API is available under the [CC0 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/).",
"title": "Wikimedia Edit Analytics",
"termsOfService": "https://foundation.wikimedia.org/wiki/Special:MyLanguage/Policy:Terms_of_Use",
"contact": {},
"version": "1"
},
"host": "wikimedia.org",
"basePath": "/api/rest_v1/metrics",
"paths": {
"/bytes-difference/absolute/aggregate/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}": {
"get": {
"description": "Returns a time series of numbers of bytes changed on a Wikimedia project, calculated as the absolute change in page length. For example, if an edit adds 5 bytes and another edit removes 10 bytes, the absolute change is 15 bytes.",
"produces": [
"application/json"
],
"summary": "Get absolute change, in bytes",
"parameters": [
{
"type": "string",
"example": "en.wikipedia.org",
"description": "Domain and subdomain of a Wikimedia project. For all projects, use `all-projects`. For data grouped by project family, use `all-[family]-projects`; for example, `all-wikipedia-projects`",
"name": "project",
"in": "path",
"required": true
},
{
"enum": [
"all-editor-types",
"anonymous",
"group-bot",
"name-bot",
"user"
],
"type": "string",
"example": "all-editor-types",
"description": "Type of editor. `group-bot` for registered accounts belonging to the bot group; `name-bot` for registered accounts with bot-like names",
"name": "editor-type",
"in": "path",
"required": true
},
{
"enum": [
"all-page-types",
"content",
"non-content"
],
"type": "string",
"example": "all-page-types",
"description": "Type of page",
"name": "page-type",
"in": "path",
"required": true
},
{
"enum": [
"daily",
"monthly"
],
"type": "string",
"example": "monthly",
"description": "Time interval between data points",
"name": "granularity",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20230101",
"description": "First day to include in YYYYMMDD format",
"name": "start",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20240101",
"description": "Last day to include in YYYYMMDD format",
"name": "end",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/entities.BytesDifferenceAbsoluteAggregateResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"404": {
"description": "Not found",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
}
}
}
},
"/bytes-difference/absolute/per-page/{project}/{page-title}/{editor-type}/{granularity}/{start}/{end}": {
"get": {
"description": "Returns a time series of numbers of bytes changed on a wiki page, calculated as the absolute change in bytes. For example, if a page has an edit that adds 5 bytes and an edit that removes 10 bytes, the absolute change is 15 bytes.",
"produces": [
"application/json"
],
"summary": "Get absolute change for a page, in bytes",
"parameters": [
{
"type": "string",
"example": "en.wikipedia.org",
"description": "Domain and subdomain of a Wikimedia project. For all projects, use `all-projects`. For data grouped by project family, use `all-[family]-projects`; for example, `all-wikipedia-projects`",
"name": "project",
"in": "path",
"required": true
},
{
"type": "string",
"example": "Solar_System",
"description": "Page title in URL-encoded format. The API sandbox encodes titles automatically",
"name": "page-title",
"in": "path",
"required": true
},
{
"enum": [
"all-editor-types",
"anonymous",
"group-bot",
"name-bot",
"user"
],
"type": "string",
"example": "all-editor-types",
"description": "Type of editor. `group-bot` for registered accounts belonging to the bot group; `name-bot` for registered accounts with bot-like names",
"name": "editor-type",
"in": "path",
"required": true
},
{
"enum": [
"daily",
"monthly"
],
"type": "string",
"example": "monthly",
"description": "Time interval between data points",
"name": "granularity",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20230101",
"description": "First day to include in YYYYMMDD format",
"name": "start",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20240101",
"description": "Last day to include in YYYYMMDD format",
"name": "end",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/entities.BytesDifferenceAbsolutePerPageResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"404": {
"description": "Not found",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
}
}
}
},
"/bytes-difference/net/aggregate/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}": {
"get": {
"description": "Returns a time series of numbers of bytes changed on a Wikimedia project, calculated as the net change in page length. For example, if an edit adds 5 bytes and another edit removes 10 bytes, the net change is -5 bytes.",
"produces": [
"application/json"
],
"summary": "Get net change, in bytes",
"parameters": [
{
"type": "string",
"example": "en.wikipedia.org",
"description": "Domain and subdomain of a Wikimedia project. For all projects, use `all-projects`. For data grouped by project family, use `all-[family]-projects`; for example, `all-wikipedia-projects`",
"name": "project",
"in": "path",
"required": true
},
{
"enum": [
"all-editor-types",
"anonymous",
"group-bot",
"name-bot",
"user"
],
"type": "string",
"example": "all-editor-types",
"description": "Type of editor. `group-bot` for registered accounts belonging to the bot group; `name-bot` for registered accounts with bot-like names",
"name": "editor-type",
"in": "path",
"required": true
},
{
"enum": [
"all-page-types",
"content",
"non-content"
],
"type": "string",
"example": "all-page-types",
"description": "Type of page",
"name": "page-type",
"in": "path",
"required": true
},
{
"enum": [
"daily",
"monthly"
],
"type": "string",
"example": "monthly",
"description": "Time interval between data points",
"name": "granularity",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20230101",
"description": "First day to include in YYYYMMDD format",
"name": "start",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20240101",
"description": "Last day to include in YYYYMMDD format",
"name": "end",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/entities.BytesDifferenceNetAggregateResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"404": {
"description": "Not found",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
}
}
}
},
"/bytes-difference/net/per-page/{project}/{page-title}/{editor-type}/{granularity}/{start}/{end}": {
"get": {
"description": "Returns a time series of numbers of bytes changed on a wiki page, calculated as the net change in bytes. For example, if a page has an edit that adds 5 bytes and an edit that removes 10 bytes, the net change is -5 bytes.",
"produces": [
"application/json"
],
"summary": "Get net change for a page, in bytes",
"parameters": [
{
"type": "string",
"example": "en.wikipedia.org",
"description": "Domain and subdomain of a Wikimedia project. For all projects, use `all-projects`. For data grouped by project family, use `all-[family]-projects`; for example, `all-wikipedia-projects`",
"name": "project",
"in": "path",
"required": true
},
{
"type": "string",
"example": "Solar_System",
"description": "Page title in URL-encoded format. The API sandbox encodes titles automatically",
"name": "page-title",
"in": "path",
"required": true
},
{
"enum": [
"all-editor-types",
"anonymous",
"group-bot",
"name-bot",
"user"
],
"type": "string",
"example": "all-editor-types",
"description": "Type of editor. `group-bot` for registered accounts belonging to the bot group; `name-bot` for registered accounts with bot-like names",
"name": "editor-type",
"in": "path",
"required": true
},
{
"enum": [
"daily",
"monthly"
],
"type": "string",
"example": "monthly",
"description": "Time interval between data points",
"name": "granularity",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20230101",
"description": "First day to include in YYYYMMDD format",
"name": "start",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20240101",
"description": "Last day to include in YYYYMMDD format",
"name": "end",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/entities.BytesDifferenceNetPerPageResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"404": {
"description": "Not found",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
}
}
}
},
"/edited-pages/aggregate/{project}/{editor-type}/{page-type}/{activity-level}/{granularity}/{start}/{end}": {
"get": {
"description": "Returns a time series of numbers of edited pages on a Wikimedia project.",
"produces": [
"application/json"
],
"summary": "Get number of edited pages",
"parameters": [
{
"type": "string",
"example": "en.wikipedia.org",
"description": "Domain and subdomain of a Wikimedia project",
"name": "project",
"in": "path",
"required": true
},
{
"enum": [
"all-editor-types",
"anonymous",
"group-bot",
"name-bot",
"user"
],
"type": "string",
"example": "all-editor-types",
"description": "Type of editor. `group-bot` for registered accounts belonging to the bot group; `name-bot` for registered accounts with bot-like names",
"name": "editor-type",
"in": "path",
"required": true
},
{
"enum": [
"all-page-types",
"content",
"non-content"
],
"type": "string",
"example": "all-page-types",
"description": "Type of page",
"name": "page-type",
"in": "path",
"required": true
},
{
"enum": [
"all-activity-levels",
"1..4-edits",
"5..24-edits",
"25..99-edits",
"100..-edits"
],
"type": "string",
"example": "all-activity-levels",
"description": "Editor activity range",
"name": "activity-level",
"in": "path",
"required": true
},
{
"enum": [
"daily",
"monthly"
],
"type": "string",
"example": "monthly",
"description": "Time interval between data points",
"name": "granularity",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20230101",
"description": "First day to include in YYYYMMDD format",
"name": "start",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20240101",
"description": "Last day to include in YYYYMMDD format",
"name": "end",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/entities.EditedPagesAggregateResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"404": {
"description": "Not found",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
}
}
}
},
"/edited-pages/new/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}": {
"get": {
"description": "Returns a time series of numbers of new pages on a Wikimedia project.",
"produces": [
"application/json"
],
"summary": "Get number of new pages",
"parameters": [
{
"type": "string",
"example": "en.wikipedia.org",
"description": "Domain and subdomain of a Wikimedia project. For all projects, use `all-projects`. For data grouped by project family, use `all-[family]-projects`; for example, `all-wikipedia-projects`",
"name": "project",
"in": "path",
"required": true
},
{
"enum": [
"all-editor-types",
"anonymous",
"group-bot",
"name-bot",
"user"
],
"type": "string",
"example": "all-editor-types",
"description": "Type of editor. `group-bot` for registered accounts belonging to the bot group; `name-bot` for registered accounts with bot-like names",
"name": "editor-type",
"in": "path",
"required": true
},
{
"enum": [
"all-page-types",
"content",
"non-content"
],
"type": "string",
"example": "all-page-types",
"description": "Type of page",
"name": "page-type",
"in": "path",
"required": true
},
{
"enum": [
"daily",
"monthly"
],
"type": "string",
"example": "monthly",
"description": "Time interval between data points",
"name": "granularity",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20230101",
"description": "First day to include in YYYYMMDD format",
"name": "start",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20240101",
"description": "Last day to include in YYYYMMDD format",
"name": "end",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/entities.EditedPagesNewResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"404": {
"description": "Not found",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
}
}
}
},
"/edited-pages/top-by-absolute-bytes-difference/{project}/{editor-type}/{page-type}/{year}/{month}/{day}": {
"get": {
"description": "Lists the 100 most-edited pages on a Wikimedia project, ordered by the absolute change in bytes. For example, if a page has an edit that adds 5 bytes and an edit that removes 10 bytes, the absolute change is 15 bytes.",
"produces": [
"application/json"
],
"summary": "List most-edited pages by number of bytes changed",
"parameters": [
{
"type": "string",
"example": "en.wikipedia.org",
"description": "Domain and subdomain of a Wikimedia project. For all projects, use `all-projects`. For data grouped by project family, use `all-[family]-projects`; for example, `all-wikipedia-projects`",
"name": "project",
"in": "path",
"required": true
},
{
"enum": [
"all-editor-types",
"anonymous",
"group-bot",
"name-bot",
"user"
],
"type": "string",
"example": "all-editor-types",
"description": "Type of editor. `group-bot` for registered accounts belonging to the bot group; `name-bot` for registered accounts with bot-like names",
"name": "editor-type",
"in": "path",
"required": true
},
{
"enum": [
"all-page-types",
"content",
"non-content"
],
"type": "string",
"example": "all-page-types",
"description": "Type of page",
"name": "page-type",
"in": "path",
"required": true
},
{
"type": "string",
"example": "2023",
"description": "Year in YYYY format",
"name": "year",
"in": "path",
"required": true
},
{
"type": "string",
"example": "01",
"description": "Month in MM format",
"name": "month",
"in": "path",
"required": true
},
{
"type": "string",
"example": "02",
"description": "Day in DD format, or `all-days`",
"name": "day",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/entities.TopByAbsoluteBytesDifferenceResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"404": {
"description": "Not found",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
}
}
}
},
"/edited-pages/top-by-edits/{project}/{editor-type}/{page-type}/{year}/{month}/{day}": {
"get": {
"description": "Lists the 100 most-edited pages on a Wikimedia project, ordered by number of edits.",
"produces": [
"application/json"
],
"summary": "List most-edited pages by number of edits",
"parameters": [
{
"type": "string",
"example": "en.wikipedia.org",
"description": "Domain and subdomain of a Wikimedia project. For all projects, use `all-projects`. For data grouped by project family, use `all-[family]-projects`; for example, `all-wikipedia-projects`",
"name": "project",
"in": "path",
"required": true
},
{
"enum": [
"all-editor-types",
"anonymous",
"group-bot",
"name-bot",
"user"
],
"type": "string",
"example": "all-editor-types",
"description": "Type of editor. `group-bot` for registered accounts belonging to the bot group; `name-bot` for registered accounts with bot-like names",
"name": "editor-type",
"in": "path",
"required": true
},
{
"enum": [
"all-page-types",
"content",
"non-content"
],
"type": "string",
"example": "all-page-types",
"description": "Type of page",
"name": "page-type",
"in": "path",
"required": true
},
{
"type": "string",
"example": "2023",
"description": "Year in YYYY format",
"name": "year",
"in": "path",
"required": true
},
{
"type": "string",
"example": "01",
"description": "Month in MM format",
"name": "month",
"in": "path",
"required": true
},
{
"type": "string",
"example": "02",
"description": "Day in DD format, or `all-days`",
"name": "day",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/entities.TopByEditsResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"404": {
"description": "Not found",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
}
}
}
},
"/edited-pages/top-by-net-bytes-difference/{project}/{editor-type}/{page-type}/{year}/{month}/{day}": {
"get": {
"description": "Lists the 100 most-edited pages on a Wikimedia project, ordered by the net change in bytes. For example, if a page has an edit that adds 5 bytes and an edit that removes 10 bytes, the net change is -5 bytes.",
"produces": [
"application/json"
],
"summary": "List most-edited pages by net difference in bytes",
"parameters": [
{
"type": "string",
"example": "en.wikipedia.org",
"description": "Domain and subdomain of a Wikimedia project. For all projects, use `all-projects`. For data grouped by project family, use `all-[family]-projects`; for example, `all-wikipedia-projects`",
"name": "project",
"in": "path",
"required": true
},
{
"enum": [
"all-editor-types",
"anonymous",
"group-bot",
"name-bot",
"user"
],
"type": "string",
"example": "all-editor-types",
"description": "Type of editor. `group-bot` for registered accounts belonging to the bot group; `name-bot` for registered accounts with bot-like names",
"name": "editor-type",
"in": "path",
"required": true
},
{
"enum": [
"all-page-types",
"content",
"non-content"
],
"type": "string",
"example": "all-page-types",
"description": "Type of page",
"name": "page-type",
"in": "path",
"required": true
},
{
"type": "string",
"example": "2023",
"description": "Year in YYYY format",
"name": "year",
"in": "path",
"required": true
},
{
"type": "string",
"example": "01",
"description": "Month in MM format",
"name": "month",
"in": "path",
"required": true
},
{
"type": "string",
"example": "02",
"description": "Day in DD format, or `all-days`",
"name": "day",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/entities.TopByNetBytesDifferenceResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"404": {
"description": "Not found",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
}
}
}
},
"/edits/aggregate/{project}/{editor-type}/{page-type}/{granularity}/{start}/{end}": {
"get": {
"description": "Returns a time series of numbers of edits to a Wikimedia project.",
"produces": [
"application/json"
],
"summary": "Get number of edits",
"parameters": [
{
"type": "string",
"example": "en.wikipedia.org",
"description": "Domain and subdomain of a Wikimedia project. For all projects, use `all-projects`. For data grouped by project family, use `all-[family]-projects`; for example, `all-wikipedia-projects`",
"name": "project",
"in": "path",
"required": true
},
{
"enum": [
"all-editor-types",
"anonymous",
"group-bot",
"name-bot",
"user"
],
"type": "string",
"example": "all-editor-types",
"description": "Type of editor. `group-bot` for registered accounts belonging to the bot group; `name-bot` for registered accounts with bot-like names",
"name": "editor-type",
"in": "path",
"required": true
},
{
"enum": [
"all-page-types",
"content",
"non-content"
],
"type": "string",
"example": "all-page-types",
"description": "Type of page",
"name": "page-type",
"in": "path",
"required": true
},
{
"enum": [
"daily",
"monthly"
],
"type": "string",
"example": "monthly",
"description": "Time interval between data points",
"name": "granularity",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20230101",
"description": "First day to include in YYYYMMDD format",
"name": "start",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20240101",
"description": "Last day to include in YYYYMMDD format",
"name": "end",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/entities.EditsAggregateResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"404": {
"description": "Not found",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
}
}
}
},
"/edits/per-page/{project}/{page-title}/{editor-type}/{granularity}/{start}/{end}": {
"get": {
"description": "Returns a time series of numbers of edits to a wiki page.",
"produces": [
"application/json"
],
"summary": "Get number of edits to a page",
"parameters": [
{
"type": "string",
"example": "en.wikipedia.org",
"description": "Domain and subdomain of a Wikimedia project. For all projects, use `all-projects`. For data grouped by project family, use `all-[family]-projects`; for example, `all-wikipedia-projects`",
"name": "project",
"in": "path",
"required": true
},
{
"type": "string",
"example": "Solar_System",
"description": "Page title in URL-encoded format. The API sandbox encodes titles automatically",
"name": "page-title",
"in": "path",
"required": true
},
{
"enum": [
"all-editor-types",
"anonymous",
"group-bot",
"name-bot",
"user"
],
"type": "string",
"example": "all-editor-types",
"description": "Type of editor. `group-bot` for registered accounts belonging to the bot group; `name-bot` for registered accounts with bot-like names",
"name": "editor-type",
"in": "path",
"required": true
},
{
"enum": [
"daily",
"monthly"
],
"type": "string",
"example": "monthly",
"description": "Time interval between data points",
"name": "granularity",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20230101",
"description": "First day to include in YYYYMMDD format",
"name": "start",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20240101",
"description": "Last day to include in YYYYMMDD format",
"name": "end",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/entities.EditsPerPageResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"404": {
"description": "Not found",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
}
}
}
},
"/edits/v3/per_editor/{user_central_id}/{page_type}/{granularity}/{start}/{end}": {
"get": {
"description": "Returns a time series of the with edit counts per user central id. Please note that this endpoint is Analytics API v3, and may not match exactly with Analytics API v1. E.g. all params and response keys use snake_case, end date parameters are exclusive, and response format has a context object and items array.",
"produces": [
"application/json"
],
"summary": "Get number of edits across all wikis by a user.",
"parameters": [
{
"type": "integer",
"example": 12345,
"description": "Global / central user id (via CentralAuth)",
"name": "user_central_id",
"in": "path",
"required": true
},
{
"enum": [
"all_page_types",
"content",
"non_content"
],
"type": "string",
"example": "all_page_types",
"description": "Type of page",
"name": "page_type",
"in": "path",
"required": true
},
{
"enum": [
"daily",
"monthly"
],
"type": "string",
"example": "monthly",
"description": "Time interval between data points",
"name": "granularity",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20230101",
"description": "First day to include in YYYYMMDD format",
"name": "start",
"in": "path",
"required": true
},
{
"type": "string",
"example": "20240101",
"description": "Last day to include in YYYYMMDD format",
"name": "end",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/entities.EditsPerEditorResponse"
}
},
"400": {
"description": "Bad request",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"404": {
"description": "Not found",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
},
"500": {
"description": "Internal server error",
"schema": {
"type": "object",
"properties": {
"detail": {
"type": "string"
},
"method": {
"type": "string"
},
"status": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
}
}
}
}
}
}
},
"definitions": {
"entities.BytesDifferenceAbsoluteAggregate": {
"type": "object",
"properties": {
"editor-type": {
"description": "Type of editor",
"type": "string",
"example": "all-editor-types"
},
"granularity": {
"description": "Time interval between data points",
"type": "string",
"example": "monthly"
},
"page-type": {
"description": "Type of page",
"type": "string",
"example": "all-page-types"
},
"project": {
"description": "Wikimedia project domain and subdomain",
"type": "string",
"example": "en.wikipedia"
},
"results": {
"description": "Array of results objects",
"type": "array",
"items": {
"$ref": "#/definitions/entities.BytesDifferenceAbsoluteAggregateResult"
}
}
}
},
"entities.BytesDifferenceAbsoluteAggregateResponse": {
"type": "object",
"properties": {
"items": {
"description": "Top-level response array",
"type": "array",
"items": {
"$ref": "#/definitions/entities.BytesDifferenceAbsoluteAggregate"
}
}
}
},
"entities.BytesDifferenceAbsoluteAggregateResult": {
"type": "object",
"properties": {
"abs_bytes_diff": {
"description": "Number of bytes changed",
"type": "integer",
"example": 3213130449
},
"timestamp": {
"description": "Timestamp in ISO 8601 format",
"type": "string",
"example": "2023-01-01T00:00:00.000Z"
}
}
},
"entities.BytesDifferenceAbsolutePerPage": {
"type": "object",
"properties": {
"editor-type": {
"description": "Type of editor",
"type": "string",
"example": "all-editor-types"
},
"granularity": {
"description": "Time interval between data points",
"type": "string",
"example": "monthly"
},
"page-title": {
"description": "Page title, with spaces replaced with underscores",
"type": "string",
"example": "Solar_System"
},
"project": {
"description": "Wikimedia project domain and subdomain",
"type": "string",
"example": "en.wikipedia"
},
"results": {
"description": "Array of results objects",
"type": "array",
"items": {
"$ref": "#/definitions/entities.BytesDifferenceAbsolutePerPageResult"
}
}
}
},
"entities.BytesDifferenceAbsolutePerPageResponse": {
"type": "object",
"properties": {
"items": {
"description": "Top-level response array",
"type": "array",
"items": {
"$ref": "#/definitions/entities.BytesDifferenceAbsolutePerPage"
}
}
}
},
"entities.BytesDifferenceAbsolutePerPageResult": {
"type": "object",
"properties": {
"abs_bytes_diff": {
"description": "Number of bytes changed",
"type": "integer",
"example": 1505
},
"timestamp": {
"description": "Timestamp in ISO 8601 format",
"type": "string",
"example": "2023-01-01T00:00:00.000Z"
}
}
},
"entities.BytesDifferenceNetAggregate": {
"type": "object",
"properties": {
"editor-type": {
"description": "Type of editor",
"type": "string",
"example": "all-editor-types"
},
"granularity": {
"description": "Time interval between data points",
"type": "string",
"example": "monthly"
},
"page-type": {
"description": "Type of page",
"type": "string",
"example": "all-page-types"
},
"project": {
"description": "Wikimedia project domain and subdomain",
"type": "string",
"example": "en.wikipedia"
},
"results": {
"description": "Array of results objects",
"type": "array",
"items": {
"$ref": "#/definitions/entities.BytesDifferenceNetAggregateResult"
}
}
}
},
"entities.BytesDifferenceNetAggregateResponse": {
"type": "object",
"properties": {
"items": {
"description": "Top-level response array",
"type": "array",
"items": {
"$ref": "#/definitions/entities.BytesDifferenceNetAggregate"
}
}
}
},
"entities.BytesDifferenceNetAggregateResult": {
"type": "object",
"properties": {
"net_bytes_diff": {
"description": "Net change in bytes. A negative value indicates bytes removed",
"type": "integer",
"example": -230801813
},
"timestamp": {
"description": "Timestamp in ISO 8601 format",
"type": "string",
"example": "2023-01-01T00:00:00.000Z"
}
}
},
"entities.BytesDifferenceNetPerPage": {
"type": "object",
"properties": {
"editor-type": {
"description": "Type of editor",
"type": "string",
"example": "all-editor-types"
},
"granularity": {
"description": "Time interval between data points",
"type": "string",
"example": "monthly"
},
"page-title": {
"description": "Page title, with spaces replaced with underscores",
"type": "string",
"example": "Solar_System"
},
"project": {
"description": "Wikimedia project domain and subdomain",
"type": "string",
"example": "en.wikipedia"
},
"results": {
"description": "Array of results objects",
"type": "array",
"items": {
"$ref": "#/definitions/entities.BytesDifferenceNetPerPageResult"
}
}
}
},
"entities.BytesDifferenceNetPerPageResponse": {
"type": "object",
"properties": {
"items": {
"description": "Top-level response array",
"type": "array",
"items": {
"$ref": "#/definitions/entities.BytesDifferenceNetPerPage"
}
}
}
},
"entities.BytesDifferenceNetPerPageResult": {
"type": "object",
"properties": {
"net_bytes_diff": {
"description": "Net change in bytes. A negative value indicates bytes removed",
"type": "integer",
"example": 105
},
"timestamp": {
"description": "Timestamp in ISO 8601 format",
"type": "string",
"example": "2023-01-01T00:00:00.000Z"
}
}
},
"entities.EditedPagesAggregate": {
"type": "object",
"properties": {
"activity-level": {
"description": "Editor activity range",
"type": "string",
"example": "all-activity-levels"
},
"editor-type": {
"description": "Type of editor",
"type": "string",
"example": "all-editor-types"
},
"granularity": {
"description": "Time interval between data points",
"type": "string",
"example": "monthly"
},
"page-type": {
"description": "Type of page",
"type": "string",
"example": "all-page-types"
},
"project": {
"description": "Wikimedia project domain and subdomain",
"type": "string",
"example": "en.wikipedia"
},
"results": {
"description": "Array of results objects",
"type": "array",
"items": {
"$ref": "#/definitions/entities.EditedPagesAggregateResult"
}
}
}
},
"entities.EditedPagesAggregateResponse": {
"type": "object",
"properties": {
"items": {
"description": "Top-level response array",
"type": "array",
"items": {
"$ref": "#/definitions/entities.EditedPagesAggregate"
}
}
}
},
"entities.EditedPagesAggregateResult": {
"type": "object",
"properties": {
"edited_pages": {
"description": "Number of edited pages",
"type": "integer",
"example": 2431429
},
"timestamp": {
"description": "Timestamp in ISO 8601 format",
"type": "string",
"example": "2023-01-01T00:00:00.000Z"
}
}
},
"entities.EditedPagesNew": {
"type": "object",
"properties": {
"editor-type": {
"description": "Type of editor",
"type": "string",
"example": "all-editor-types"
},
"granularity": {
"description": "Time interval between data points",
"type": "string",
"example": "monthly"
},
"page-type": {
"description": "Type of page",
"type": "string",
"example": "all-page-types"
},
"project": {
"description": "Wikimedia project domain and subdomain",
"type": "string",
"example": "en.wikipedia"
},
"results": {
"description": "Array of results objects",
"type": "array",
"items": {
"$ref": "#/definitions/entities.EditedPagesNewResult"
}
}
}
},
"entities.EditedPagesNewResponse": {
"type": "object",
"properties": {
"items": {
"description": "Top-level response array",
"type": "array",
"items": {
"$ref": "#/definitions/entities.EditedPagesNew"
}
}
}
},
"entities.EditedPagesNewResult": {
"type": "object",
"properties": {
"new_pages": {
"description": "Number of new pages",
"type": "integer",
"example": 184731
},
"timestamp": {
"description": "Timestamp in ISO 8601 format",
"type": "string",
"example": "2023-01-01T00:00:00.000Z"
}
}
},
"entities.EditsAggregate": {
"type": "object",
"properties": {
"editor-type": {
"description": "Type of editor",
"type": "string",
"example": "all-editor-types"
},
"granularity": {
"description": "Time interval between data points",
"type": "string",
"example": "monthly"
},
"page-type": {
"description": "Type of page",
"type": "string",
"example": "all-page-types"
},
"project": {
"description": "Wikimedia project domain and subdomain",
"type": "string",
"example": "en.wikipedia"
},
"results": {
"description": "Array of results objects",
"type": "array",
"items": {
"$ref": "#/definitions/entities.EditsAggregateResult"
}
}
}
},
"entities.EditsAggregateResponse": {
"type": "object",
"properties": {
"items": {
"description": "Top-level response array",
"type": "array",
"items": {
"$ref": "#/definitions/entities.EditsAggregate"
}
}
}
},
"entities.EditsAggregateResult": {
"type": "object",
"properties": {
"edits": {
"description": "Number of edits",
"type": "integer",
"example": 5771719
},
"timestamp": {
"description": "Timestamp in ISO 8601 format",
"type": "string",
"example": "2023-01-01T00:00:00.000Z"
}
}
},
"entities.EditsPerEditorContext": {
"type": "object",
"properties": {
"end": {
"description": "Last date of the time period in ISO-8601 format (exclusive: end date is not included in the response)",
"type": "string",
"example": "2024-01-01T00:00:00.000Z"
},
"endpoint": {
"description": "API endpoint used",
"type": "string",
"example": "edits/per_editor"
},
"granularity": {
"description": "Time interval between data points (e.g. daily, monthtly)",
"type": "string",
"example": "monthly"
},
"page_type": {
"description": "Type of page",
"type": "string",
"example": "content"
},
"start": {
"description": "First date of the time period in ISO-8601 format",
"type": "string",
"example": "2023-01-01T00:00:00.000Z"
},
"user_central_id": {
"description": "Global / central user id (via CentralAuth)",
"type": "integer",
"example": 12345
}
}
},
"entities.EditsPerEditorItem": {
"type": "object",
"properties": {
"edit_count": {
"description": "Number of edits",
"type": "integer",
"example": 25
},
"timestamp": {
"description": "Timestamp in ISO 8601 format",
"type": "string",
"example": "2023-01-01T00:00:00.000Z"
}
}
},
"entities.EditsPerEditorResponse": {
"type": "object",
"properties": {
"context": {
"$ref": "#/definitions/entities.EditsPerEditorContext"
},
"items": {
"description": "Array of timeseries results",
"type": "array",
"items": {
"$ref": "#/definitions/entities.EditsPerEditorItem"
}
}
}
},
"entities.EditsPerPage": {
"type": "object",
"properties": {
"editor-type": {
"description": "Type of editor",
"type": "string",
"example": "all-editor-types"
},
"granularity": {
"description": "Time interval between data points",
"type": "string",
"example": "monthly"
},
"page-title": {
"description": "Page title, with spaces replaced with underscores",
"type": "string",
"example": "Solar_System"
},
"project": {
"description": "Wikimedia project domain and subdomain",
"type": "string",
"example": "en.wikipedia"
},
"results": {
"description": "Array of results objects",
"type": "array",
"items": {
"$ref": "#/definitions/entities.EditsPerPageResult"
}
}
}
},
"entities.EditsPerPageResponse": {
"type": "object",
"properties": {
"items": {
"description": "Top-level response array",
"type": "array",
"items": {
"$ref": "#/definitions/entities.EditsPerPage"
}
}
}
},
"entities.EditsPerPageResult": {
"type": "object",
"properties": {
"edits": {
"description": "Number of edits",
"type": "integer",
"example": 25
},
"timestamp": {
"description": "Timestamp in ISO 8601 format",
"type": "string",
"example": "2023-01-01T00:00:00.000Z"
}
}
},
"entities.TopByAbsoluteBytesDifference": {
"type": "object",
"properties": {
"editor-type": {
"description": "Type of editor",
"type": "string",
"example": "all-editor-types"
},
"granularity": {
"description": "Time interval between data points",
"type": "string",
"example": "daily"
},
"page-type": {
"description": "Type of page",
"type": "string",
"example": "all-page-types"
},
"project": {
"description": "Wikimedia project domain and subdomain",
"type": "string",
"example": "en.wikipedia"
},
"results": {
"description": "Array of results objects",
"type": "array",
"items": {
"$ref": "#/definitions/entities.TopByAbsoluteBytesDifferenceResult"
}
}
}
},
"entities.TopByAbsoluteBytesDifferenceResponse": {
"type": "object",
"properties": {
"items": {
"description": "Top-level response array",
"type": "array",
"items": {
"$ref": "#/definitions/entities.TopByAbsoluteBytesDifference"
}
}
}
},
"entities.TopByAbsoluteBytesDifferenceResult": {
"type": "object",
"properties": {
"timestamp": {
"description": "Timestamp in ISO 8601 format",
"type": "string",
"example": "2023-01-02T00:00:00.000Z"
},
"top": {
"description": "Array of page objects",
"type": "array",
"items": {
"$ref": "#/definitions/entities.TopByAbsoluteBytesDifferenceTop"
}
}
}
},
"entities.TopByAbsoluteBytesDifferenceTop": {
"type": "object",
"properties": {
"abs_bytes_diff": {
"description": "Number of bytes changed",
"type": "integer",
"example": 1329730
},
"page_title": {
"description": "Page title, with spaces replaced with underscores",
"type": "string",
"example": "Project:Sandbox"
},
"rank": {
"description": "Page rank",
"type": "integer",
"example": 1
}
}
},
"entities.TopByEdits": {
"type": "object",
"properties": {
"editor-type": {
"description": "Type of editor",
"type": "string",
"example": "all-editor-types"
},
"granularity": {
"description": "Time interval between data points",
"type": "string",
"example": "daily"
},
"page-type": {
"description": "Type of page",
"type": "string",
"example": "all-page-types"
},
"project": {
"description": "Wikimedia project domain and subdomain",
"type": "string",
"example": "en.wikipedia"
},
"results": {
"description": "Array of results objects",
"type": "array",
"items": {
"$ref": "#/definitions/entities.TopByEditsResult"
}
}
}
},
"entities.TopByEditsResponse": {
"type": "object",
"properties": {
"items": {
"description": "Top-level response array",
"type": "array",
"items": {
"$ref": "#/definitions/entities.TopByEdits"
}
}
}
},
"entities.TopByEditsResult": {
"type": "object",
"properties": {
"timestamp": {
"description": "Timestamp in ISO 8601 format",
"type": "string",
"example": "2023-01-02T00:00:00.000Z"
},
"top": {
"description": "Array of page objects",
"type": "array",
"items": {
"$ref": "#/definitions/entities.TopByEditsTop"
}
}
}
},
"entities.TopByEditsTop": {
"type": "object",
"properties": {
"edits": {
"description": "Number of edits",
"type": "integer",
"example": 171
},
"page_title": {
"description": "Page title, with spaces replaced with underscores",
"type": "string",
"example": "Piolets_d'Or"
},
"rank": {
"description": "Page rank",
"type": "integer",
"example": 1
}
}
},
"entities.TopByNetBytesDifference": {
"type": "object",
"properties": {
"editor-type": {
"description": "Type of editor",
"type": "string",
"example": "all-editor-types"
},
"granularity": {
"description": "Time interval between data points",
"type": "string",
"example": "daily"
},
"page-type": {
"description": "Type of page",
"type": "string",
"example": "all-page-types"
},
"project": {
"description": "Wikimedia project domain and subdomain",
"type": "string",
"example": "en.wikipedia"
},
"results": {
"description": "Array of results objects",
"type": "array",
"items": {
"$ref": "#/definitions/entities.TopByNetBytesDifferenceResult"
}
}
}
},
"entities.TopByNetBytesDifferenceResponse": {
"type": "object",
"properties": {
"items": {
"description": "Top-level response array",
"type": "array",
"items": {
"$ref": "#/definitions/entities.TopByNetBytesDifference"
}
}
}
},
"entities.TopByNetBytesDifferenceResult": {
"type": "object",
"properties": {
"timestamp": {
"description": "Timestamp in ISO 8601 format",
"type": "string",
"example": "2020-12-01T00:00:00.000Z"
},
"top": {
"description": "Array of page objects",
"type": "array",
"items": {
"$ref": "#/definitions/entities.TopByNetBytesDifferenceTop"
}
}
}
},
"entities.TopByNetBytesDifferenceTop": {
"type": "object",
"properties": {
"net_bytes_diff": {
"description": "Net change in bytes. A negative value indicates bytes removed",
"type": "integer",
"example": 989304
},
"page_title": {
"description": "Page title, with spaces replaced with underscores",
"type": "string",
"example": "Project:Sandbox"
},
"rank": {
"description": "Page rank",
"type": "integer",
"example": 1
}
}
}
}
}