> ## 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.

# Get user spots

Returns the ad spots you have configured in the [spot connector](https://adgreg.com/dashboard/spotconnector) 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](/api-reference/endpoint/user-sites)), not an adnetwork site ID.
* **`user_spot_type`** — filter by one of your user-defined groups.


## OpenAPI

````yaml GET /user-spots
openapi: 3.1.0
info:
  title: AdGreg API
  version: 0.1.0
servers:
  - url: https://api.adgreg.com
security: []
paths:
  /user-spots:
    get:
      tags:
        - Dashboard configuration
      summary: Get User Spots
      operationId: get_user_spots_user_spots_get
      parameters:
        - name: ad_network
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/AdNetwork'
              - type: 'null'
            title: Ad Network
        - name: site_id
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            title: Site Id
        - name: user_spot_type
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: User Spot Type
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 10
            default: 100
            title: Page Size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSpotsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    AdNetwork:
      type: string
      enum:
        - exoclick
        - trafficstars
        - kadam
        - clickadilla
        - onclicka
        - twinred
        - trafficshop
        - hilltop
      title: AdNetwork
    UserSpotsResponse:
      properties:
        page:
          type: integer
          title: Page
        sites:
          type: integer
          title: Sites
        page_size:
          type: integer
          title: Page Size
        page_count:
          type: integer
          title: Page Count
        response:
          items:
            $ref: '#/components/schemas/UserSpotItem'
          type: array
          title: Response
      type: object
      required:
        - page
        - sites
        - page_size
        - page_count
        - response
      title: UserSpotsResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserSpotItem:
      properties:
        website:
          type: string
          title: Website
        website_id:
          type: integer
          title: Website Id
        configured_spots:
          items:
            $ref: '#/components/schemas/ConfiguredSpot'
          type: array
          title: Configured Spots
      type: object
      required:
        - website
        - website_id
        - configured_spots
      title: UserSpotItem
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ConfiguredSpot:
      properties:
        adnetwork:
          type: string
          title: Adnetwork
        api_spot_id:
          type: string
          title: Api Spot Id
        api_spot_name:
          type: string
          title: Api Spot Name
        user_spot_type:
          type: string
          title: User Spot Type
        api_site_id:
          type: string
          title: Api Site Id
        api_site_name:
          type: string
          title: Api Site Name
      type: object
      required:
        - adnetwork
        - api_spot_id
        - api_spot_name
        - user_spot_type
        - api_site_id
        - api_site_name
      title: ConfiguredSpot
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````