mirror of
https://github.com/shlinkio/shlink.git
synced 2024-12-20 06:03:37 -06:00
82 lines
3.1 KiB
JSON
82 lines
3.1 KiB
JSON
{
|
|
"get": {
|
|
"tags": [
|
|
"ShortCodes",
|
|
"Visits"
|
|
],
|
|
"summary": "List visits for short URL",
|
|
"description": "Get the list of visits on provided short code.",
|
|
"parameters": [
|
|
{
|
|
"name": "shortCode",
|
|
"in": "path",
|
|
"type": "string",
|
|
"description": "The shortCode from which we want to get the visits.",
|
|
"required": true
|
|
},
|
|
{
|
|
"$ref": "../parameters/Authorization.json"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "List of visits.",
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"visits": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "../definitions/Visit.json"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"examples": {
|
|
"application/json": {
|
|
"visits": {
|
|
"data": [
|
|
{
|
|
"referer": "https://twitter.com",
|
|
"date": "2015-08-20T05:05:03+04:00",
|
|
"remoteAddr": "10.20.30.40",
|
|
"userAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0 Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0"
|
|
},
|
|
{
|
|
"referer": "https://t.co",
|
|
"date": "2015-08-20T05:05:03+04:00",
|
|
"remoteAddr": "11.22.33.44",
|
|
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36"
|
|
},
|
|
{
|
|
"referer": null,
|
|
"date": "2015-08-20T05:05:03+04:00",
|
|
"remoteAddr": "110.220.5.6",
|
|
"userAgent": "some_web_crawler/1.4"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "The short code does not belong to any short URL.",
|
|
"schema": {
|
|
"$ref": "../definitions/Error.json"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Unexpected error.",
|
|
"schema": {
|
|
"$ref": "../definitions/Error.json"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|