From 0b96a79c410cce8cf755b0d1ab3316ba961e8a85 Mon Sep 17 00:00:00 2001 From: Alejandro Celaya Date: Mon, 2 Jan 2023 20:02:50 +0100 Subject: [PATCH] Updated async API docs --- docs/async-api/async-api.json | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/docs/async-api/async-api.json b/docs/async-api/async-api.json index 3b59e8e5..6ce83784 100644 --- a/docs/async-api/async-api.json +++ b/docs/async-api/async-api.json @@ -116,7 +116,11 @@ "format": "date-time", "description": "The date in which the short URL was created in ISO format." }, + "visitsSummary": { + "$ref": "#/components/schemas/VisitsSummary" + }, "visitsCount": { + "deprecated": true, "type": "integer", "description": "The number of visits that this short URL has received." }, @@ -149,7 +153,11 @@ "shortUrl": "https://doma.in/12C18", "longUrl": "https://store.steampowered.com", "dateCreated": "2016-08-21T20:34:16+02:00", - "visitsCount": 328, + "visitsSummary": { + "total": 328, + "nonBots": 285, + "bots": 43 + }, "tags": [ "games", "tech" @@ -189,6 +197,24 @@ } } }, + "VisitsSummary": { + "type": "object", + "required": ["total", "nonBots", "bots"], + "properties": { + "total": { + "description": "The total amount of visits", + "type": "number" + }, + "nonBots": { + "description": "The amount of visits which were not identified as bots", + "type": "number" + }, + "bots": { + "description": "The amount of visits that were identified as potential bots", + "type": "number" + } + } + }, "Visit": { "type": "object", "properties": {