List Campaigns

curl --request GET \
  --url https://jmpy.me/api/v1/campaigns \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "url_count": 123,
      "total_clicks": 123,
      "created_at": "<string>"
    }
  ],
  "meta": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "total_pages": 123
  }
}

GET

campaigns

List Campaigns

curl --request GET \
  --url https://jmpy.me/api/v1/campaigns \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "url_count": 123,
      "total_clicks": 123,
      "created_at": "<string>"
    }
  ],
  "meta": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "total_pages": 123
  }
}

Retrieve a list of your campaigns with pagination and filtering options.

Query Parameters

page

integer

default:"1"

The page number to retrieve.Default: 1

limit

integer

default:"20"

The number of campaigns to return per page. Max 100.Default: 20

string

Search for campaigns by name. You can also use name as an alias for this parameter.

range

string

Filter by relative date range.Allowed values:

24h: Last 24 hours
7d: Last 7 days
30d: Last 30 days
90d: Last 90 days
1y or last_year: Last 365 days
all: All time (default)

start_date

string

Filter by specific start date (ISO 8601). Cannot be used with range.

end_date

string

Filter by specific end date (ISO 8601). Cannot be used with range.

Response

success

boolean

Indicates if the request was successful.

data

array

List of campaigns.

Show Campaign Object

string

Unique identifier for the campaign.

name

string

The campaign name.

status

string

Current status of the campaign.

url_count

number

Number of short URLs associated with this campaign.

total_clicks

number

Total aggregated clicks.

created_at

string

Creation timestamp.

Request Examples

# Basic List
curl -X GET "https://jmpy.me/api/v1/campaigns?limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Filtered by Date Range (Last 30 Days) and Search
curl -X GET "https://jmpy.me/api/v1/campaigns?range=30d&search=summer" \
  -H "Authorization: Bearer YOUR_API_KEY"

const fetch = require('node-fetch');

const params = new URLSearchParams({
  page: '1',
  limit: '20',
  range: '30d',      // options: 24h, 7d, 30d, 90d, 1y, all
  search: 'marketing' // optional search term
});

const response = await fetch(`https://jmpy.me/api/v1/campaigns?${params}`, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const data = await response.json();

import axios from 'axios';

const response = await axios.get(
  'https://jmpy.me/api/v1/campaigns',
  {
    params: {
      page: 1,
      limit: 20,
      range: '7d', // Last 7 days
      search: 'Social Media'
    },
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

import requests

url = "https://jmpy.me/api/v1/campaigns"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

# Example filtering for last 24 hours
params = {
    "page": 1,
    "limit": 20,
    "range": "24h",
    "search": "Flash Sale"
}

response = requests.get(url, headers=headers, params=params)

<?php
$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://jmpy.me/api/v1/campaigns', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY'],
    'query' => [
        'page' => 1,
        'limit' => 20,
        'range' => '30d',
        'search' => 'Winter'
    ]
]);
?>

package main

import "net/http"

func main() {
    req, _ := http.NewRequest("GET", "https://jmpy.me/api/v1/campaigns", nil)
    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
    
    q := req.URL.Query()
    q.Add("page", "1")
    q.Add("limit", "20")
    q.Add("range", "30d")
    q.Add("search", "Promo")
    req.URL.RawQuery = q.Encode()
    
    http.DefaultClient.Do(req)
}

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.URI;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
// Example: GET /campaigns?range=30d&search=New
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://jmpy.me/api/v1/campaigns?range=30d&search=New"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
client.send(request, HttpResponse.BodyHandlers.ofString());

Response Examples

200 OK
401 Unauthorized
429 Rate Limited

{
  "success": true,
  "data": [
    {
      "id": "110e8400-e29b-41d4-a716-446655440000",
      "name": "Q1 Marketing Campaign",
      "url_count": 15,
      "total_clicks": 4523,
      "status": "active",
      "created_at": "2024-01-15T10:30:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 5,
    "total_pages": 1
  }
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests, please try again later"
  }
}

Get Campaign

View detailed statistics for a campaign

Create Campaign

Start a new campaign

Create Campaign Get Campaign

​Query Parameters

​Response

​Request Examples

​Response Examples

​Related Endpoints

Get Campaign

Create Campaign

Query Parameters

Response

Request Examples

Response Examples

Related Endpoints