Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefanofranco/yourls-api-shorturl-analytics
This plugin adds a custom API action 'shorturl_analytics' to show stats in a range of dates.
https://github.com/stefanofranco/yourls-api-shorturl-analytics
Last synced: 14 days ago
JSON representation
This plugin adds a custom API action 'shorturl_analytics' to show stats in a range of dates.
- Host: GitHub
- URL: https://github.com/stefanofranco/yourls-api-shorturl-analytics
- Owner: stefanofranco
- License: mit
- Created: 2024-03-27T09:29:04.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-25T09:16:50.000Z (5 months ago)
- Last Synced: 2024-08-02T06:14:27.197Z (4 months ago)
- Language: PHP
- Size: 20.5 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - API ShortUrl Analytics - Add a "shorturl_analytics" action to the API to get the statistics of a specific shortURL in a range of dates. (Plugins / A)
README
# Plugin for YOURLS: API ShortURL Analytics
[](https://github.com/stefanofranco/yourls-api-shorturl-analytics)
[](https://opensource.org/licenses/MIT)
## Description
Yourls API ShortURL Analytics is a plugin for Yourls that provides analytics for short URLs via a custom API action. This plugin allows users to retrieve detailed statistics for short URLs within a specified date range.
## Requirements
This plugin requires YOURLS version 1.7.3 and above and Php >= 7.0.
**Note**: Please, if you've tested it with other versions and it works fine, contact me and I will update this section.
## Installation
Download the latest release from the releases page.
Extract the contents to a folder named `yourls-api-shorturl-analytics` within the `/user/plugins` directory of your Yourls installation.
Activate the plugin from the Plugins administration page (http://yourls-site.com/admin/plugins.php).
You're ready to go!
License
This package is licensed under the MIT License.
## Usage
This plugin extends Yourls API functionality to include a custom action for retrieving analytics data for short URLs. The action can be accessed through the endpoint `/yourls-api.php`, and requires the following parameters:
- `date`: The start date for the analytics data (required).
- `date_end`: The end date for the analytics data (optional, defaults to the start date if not provided).
- `shorturl`: The short URL for which analytics data is requested (required).
### Example - Stats for a specific date
```bash
curl -X GET "http://yourls-site.com/yourls-api.php?signature=YourSignature&action=shorturl_analytics&date=2024-01-01&shorturl=abc123"
```
```bash
# Sample result for a specific date
# Parameters: date = 2024-01-01
{
"statusCode": 200,
"message": "success",
"stats": {
"total_clicks": 15, # Total clicks (lifetime)
"range_clicks": 15, # Total clicks (in the range)
"daily_clicks": {
"2024-01-01": 15 # Total clicks (in the specific date)
}
}
}
```
### Example - Stats for a date range
```bash
curl -X GET "http://yourls-site.com/yourls-api.php?signature=YourSignature&action=shorturl_analytics&date=2024-01-01&date_end=2024-12-31&shorturl=abc123"
```
```bash
# Sample result for a date range
# Parameters: date = 2024-01-01, date_end = 2024-01-05
{
"statusCode": 200,
"message": "success",
"stats": {
"total_clicks": 120, # Total clicks (lifetime)
"range_clicks": 24, # Total clicks (in the range)
"daily_clicks": {
"2024-01-01": 15 # Total clicks (in the specific date)
"2024-01-02": 8,
"2024-01-03": 1,
"2024-01-04": 0,
"2024-01-05": 0
}
}
}
```
## Author
Created by [Stefano Franco](https://github.com/stefanofranco/yourls-api-shorturl-analytics).