Skip to main content
GET
/
user-spots
Get User Spots
curl --request GET \
  --url https://api.example.com/user-spots \
  --header 'X-API-Key: <api-key>'
{
  "page": 123,
  "sites": 123,
  "page_size": 123,
  "page_count": 123,
  "response": [
    {
      "website": "<string>",
      "website_id": 123,
      "configured_spots": [
        {
          "adnetwork": "<string>",
          "api_spot_id": "<string>",
          "api_spot_name": "<string>",
          "user_spot_type": "<string>",
          "api_site_id": "<string>",
          "api_site_name": "<string>"
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.adgreg.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns the ad spots you have configured in the spot connector in your Adgreg dashboard. In the spot connector, spots from all adnetwork sites linked to an Adgreg website are fetched automatically. You then assign each spot a group — a user-defined label such as popunder or banner that categorises spots across adnetworks. This group is exposed as the user_spot_type field.
  • site_id — filter by an Adgreg website ID (the website_id from Get user sites), not an adnetwork site ID.
  • user_spot_type — filter by one of your user-defined groups.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
ad_network
enum<string> | null
Available options:
exoclick,
trafficstars,
kadam,
clickadilla,
onclicka,
twinred,
trafficshop,
hilltop
​
site_id
integer | null
​
user_spot_type
string | null
​
page
integer
default:1
Required range: x >= 1
​
page_size
integer
default:100
Required range: 10 <= x <= 100

Response

Successful Response

​
page
integer
required
​
sites
integer
required
​
page_size
integer
required
​
page_count
integer
required
​
response
UserSpotItem · object[]
required