diff --git a/docs/swagger/definitions/ShortUrl.json b/docs/swagger/definitions/ShortUrl.json index ab66f506..4d5d9f2d 100644 --- a/docs/swagger/definitions/ShortUrl.json +++ b/docs/swagger/definitions/ShortUrl.json @@ -38,7 +38,7 @@ "description": "**[DEPRECATED]** Use `visitsSummary.total` instead." }, "visitsSummary": { - "$ref": "./ShortUrlVisitsSummary.json" + "$ref": "./VisitsSummary.json" }, "tags": { "type": "array", diff --git a/docs/swagger/definitions/VisitStats.json b/docs/swagger/definitions/VisitStats.json index 2a97f597..2ed24375 100644 --- a/docs/swagger/definitions/VisitStats.json +++ b/docs/swagger/definitions/VisitStats.json @@ -1,14 +1,22 @@ { "type": "object", - "required": ["visitsCount", "orphanVisitsCount"], + "required": ["nonOrphanVisits", "orphanVisits", "visitsCount", "orphanVisitsCount"], "properties": { + "nonOrphanVisits": { + "$ref": "./VisitsSummary.json" + }, + "orphanVisits": { + "$ref": "./VisitsSummary.json" + }, "visitsCount": { + "deprecated": true, "type": "number", - "description": "The total amount of visits received on any short URL." + "description": "**[DEPRECATED]** Use nonOrphanVisits.total instead" }, "orphanVisitsCount": { + "deprecated": true, "type": "number", - "description": "The total amount of visits that could not be matched to a short URL (visits to the base URL, an invalid short URL or any other kind of 404)." + "description": "**[DEPRECATED]** Use orphanVisits.total instead" } } } diff --git a/docs/swagger/definitions/ShortUrlVisitsSummary.json b/docs/swagger/definitions/VisitsSummary.json similarity index 83% rename from docs/swagger/definitions/ShortUrlVisitsSummary.json rename to docs/swagger/definitions/VisitsSummary.json index 404b7a75..c59b2ccd 100644 --- a/docs/swagger/definitions/ShortUrlVisitsSummary.json +++ b/docs/swagger/definitions/VisitsSummary.json @@ -3,7 +3,7 @@ "required": ["total", "nonBots", "bots"], "properties": { "total": { - "description": "The total amount of visits that this short URL has received.", + "description": "The total amount of visits.", "type": "integer" }, "nonBots": { diff --git a/docs/swagger/paths/v2_visits.json b/docs/swagger/paths/v2_visits.json index ded6ac6b..3db0ef67 100644 --- a/docs/swagger/paths/v2_visits.json +++ b/docs/swagger/paths/v2_visits.json @@ -31,8 +31,16 @@ }, "example": { "visits": { - "visitsCount": 1569874, - "orphanVisitsCount": 71345 + "nonOrphanVisits": { + "total": 64994, + "nonBots": 64986, + "bots": 8 + }, + "orphanVisits": { + "total": 37, + "nonBots": 34, + "bots": 3 + } } } }