SAREpush
  • INTRODUCTION
  • Platform Support
  • JAVASCRIPT LIBRARY
    • Installing library on website
    • Installing library through GTM
    • Tagging a subscriber using library
    • Preview subscriber's tags in our platform.
    • Sending shopping cart events using library
  • REST API
    • Introduction
    • Retrieving a list of websites
    • Retrieving JS code for specific website
    • Creating campaign to all subscribers
    • Creating campaign to particular locations
    • Creating campaign to particular tags
    • Creating campaign to particular segments
    • Sending message to specific subscriber
    • Sending message to test subscribers
    • Retrieving a list of segments
    • Retrieving a list of locations
    • Retrieving a list of tags
    • Retrieving a list of subscribers
  • PLUGINS
    • Installing WordPress plugin
  • CAMPAIGNS
    • Delivery automation
      • Welcome notification
      • When leave website
      • When visit specific web page
      • When spend X time on specific web page
    • Delivery to audience
      • Send to all subscribers
      • Send to particular segments
      • Send to particular tags
      • Send to test segment
    • Delivery scheduling
      • Send at a particular time
      • Sent recurring
    • Message personalization
    • Message preview
    • Message time to live
    • Images and icons
  • User management
    • User Management
    • Permission table
  • Product feed
    • What is XML Product Feed?
Powered by GitBook
On this page
  1. REST API

Retrieving a list of subscribers

To retrieve a list of subscribers, submit a GET request to:

https://push-api.sare.pl/v1/subscribers/<YOUR_WEBSITE_UID>

Query parameters

Description

limit

Number of entries (Optional)

offset

Indicates entry number to start from (Optional)

segment

From specified segment (Optional)

PHP example

$url = "https://push-api.sare.pl/v1/subscribers/<YOUR_WEBSITE_UID>";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Basic <YOUR_API_KEY>']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = curl_exec($ch);

Bash example

curl --include \
     --header "Authorization: Basic <YOUR_API_KEY>" \
     https://push-api.sare.pl/v1/subscribers/<YOUR_WEBSITE_UID>

Response example

[
  {
    "uid": "426bf38b8d799f028aa1a7aadde10272",
    "subscribed": 1568127299,
    "visited": 1568127328,
    "sessions": 1,
    "visits": 2,
    "lastActive": 1568127398,
    "language": "pl",
    "city":"Kielce",
    "country":"Poland",
    "system": "macos",
    "browser": "firefox",
    "device": "desktop",
    "sent": 47,
    "delivered": 1,
    "clicked": 1,
    "test": 1
  },
  {
    "uid": "ed56eb3d462ff94abcdf5822e4171d0d",
    "subscribed": 1569436489,
    "visited": 1569436592,
    "sessions": 1,
    "visits": 4,
    "lastActive": 1569876317,
    "language": "pl",
    "city":"Kielce",
    "country":"Poland",
    "system": "windows",
    "browser": "opera",
    "device": "desktop",
    "sent": 23,
    "delivered": 2,
    "clicked": 0,
    "test": 0
  }
]
PreviousRetrieving a list of tagsNextInstalling WordPress plugin

Last updated 4 years ago