> ## Documentation Index
> Fetch the complete documentation index at: https://docs.useroulette.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get shared link access logs

> Retrieve access logs for a shared link showing who viewed it,
when, and from where.




## OpenAPI

````yaml openapi.json get /accounts/{account_id}/shared-links/{id}/access-logs
openapi: 3.1.0
info:
  title: Roulette API
  version: 1.0.0
  description: >
    The Roulette API provides programmatic access to manage your VC deal flow,

    companies, contacts, and related data.


    ## Authentication


    All API requests require authentication using a Bearer token. Include your
    API key

    in the `Authorization` header:


    ```

    Authorization: Bearer YOUR_API_KEY

    ```


    You can generate API keys from your account settings in the Roulette
    dashboard.


    ## Rate Limiting


    API requests are rate limited to ensure fair usage. Current limits:

    - 1000 requests per minute per API key

    - 100 requests per second per API key


    Rate limit headers are included in all responses:

    - `X-RateLimit-Limit`: Maximum requests per window

    - `X-RateLimit-Remaining`: Requests remaining in current window

    - `X-RateLimit-Reset`: Unix timestamp when the window resets


    ## Pagination


    List endpoints support cursor-based pagination using the following query
    parameters:

    - `page`: Page number (default: 1)

    - `limit`: Items per page (default: 25, max: 100)


    Paginated responses include pagination metadata:

    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "limit": 25,
        "has_next": true,
        "has_prev": false
      }
    }

    ```


    **Note**: For performance reasons, total counts (`total`, `total_pages`) are
    not included.

    Use `has_next` and `has_prev` to determine if more pages exist.


    ## Errors


    The API uses standard HTTP status codes and returns errors in a consistent
    format:


    ```json

    {
      "success": false,
      "error": "Human readable error message",
      "data": null
    }

    ```


    Common status codes:

    - `400` Bad Request - Invalid parameters or request body

    - `401` Unauthorized - Missing or invalid API key

    - `403` Forbidden - Valid API key but insufficient permissions

    - `404` Not Found - Resource not found

    - `429` Too Many Requests - Rate limit exceeded

    - `500` Internal Server Error - Server-side error
  termsOfService: https://www.useroulette.com/terms
  contact:
    name: Roulette API Support
    email: support@useroulette.com
    url: https://www.useroulette.com/support
  license:
    name: Proprietary
    url: https://www.useroulette.com/license
servers:
  - url: https://www.useroulette.com/api/v1
    description: Production server
  - url: http://localhost:3000/api/v1
    description: Local development server
security:
  - BearerAuth: []
tags:
  - name: Companies
    description: >
      Manage companies in your deal flow pipeline. Companies represent potential

      investment opportunities with associated pitch decks, contacts, and
      metadata.
  - name: Company Statuses
    description: |
      Manage deal flow stages/statuses for organizing companies through your
      investment pipeline (e.g., "Initial Review", "Due Diligence", "Closed").
  - name: Company Settings
    description: |
      Configure custom fields and settings for company tracking.
  - name: Contacts
    description: |
      Manage contacts associated with companies, including founders, executives,
      and other key personnel.
  - name: Form Submissions
    description: |
      Access form submissions from integrated platforms like Tally.
  - name: Emails
    description: |
      Manage emails linked to companies and contacts.
  - name: Meeting Minutes
    description: |
      Store and retrieve meeting notes and minutes related to companies.
  - name: Shared Links
    description: |
      Create and manage secure shareable links for company portfolios.
  - name: Integrations
    description: |
      Configure third-party integrations (Tally, Specter, etc.).
  - name: Investor Dashboard
    description: |
      Configure and manage investor-facing portfolio dashboards.
  - name: Dashboard
    description: |
      Access aggregated dashboard data and analytics.
  - name: Team Members
    description: |
      View team members and their roles within your account.
  - name: Short URLs
    description: |
      Create shortened URLs with optional password protection.
paths:
  /accounts/{account_id}/shared-links/{id}/access-logs:
    get:
      tags:
        - Shared Links
      summary: Get shared link access logs
      description: |
        Retrieve access logs for a shared link showing who viewed it,
        when, and from where.
      operationId: getSharedLinkAccessLogs
      parameters:
        - $ref: '#/components/parameters/AccountIdParam'
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/PageParam'
        - $ref: '#/components/parameters/LimitParam'
      responses:
        '200':
          description: Access logs
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      access_logs:
                        type: array
                        items:
                          $ref: '#/components/schemas/SharedLinkAccessLog'
                      pagination: e1dabf7d-a15b-4ce8-8810-ad59e93fe0e5
              example:
                success: true
                data:
                  access_logs:
                    - id: log-uuid-1
                      shared_link_id: link-uuid
                      ip_address: 192.168.x.x
                      user_agent: Mozilla/5.0...
                      country: US
                      accessed_at: '2024-01-20T15:30:00Z'
                    - id: log-uuid-2
                      shared_link_id: link-uuid
                      ip_address: 10.0.x.x
                      user_agent: Chrome/120...
                      country: UK
                      accessed_at: '2024-01-19T10:15:00Z'
                  pagination:
                    page: 1
                    limit: 20
                    total: 42
                    total_pages: 3
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
components:
  parameters:
    AccountIdParam:
      name: account_id
      in: path
      required: true
      description: The unique identifier of the account/team
      schema:
        type: string
        format: uuid
      example: 550e8400-e29b-41d4-a716-446655440000
    PageParam:
      name: page
      in: query
      required: false
      description: Page number for pagination (starts at 1)
      schema:
        type: integer
        minimum: 1
        default: 1
      example: 1
    LimitParam:
      name: limit
      in: query
      required: false
      description: Number of items per page (max 100)
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      example: 20
  schemas:
    SharedLinkAccessLog:
      type: object
      properties:
        id:
          type: string
          format: uuid
        shared_link_id:
          type: string
          format: uuid
        ip_address:
          type: string
          description: Visitor's IP address (anonymized)
        user_agent:
          type: string
          description: Browser/device information
        country:
          type: string
          description: Detected country
          example: US
        accessed_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: Human-readable error message
          example: Invalid request body
        data:
          type: 'null'
          example: null
        authType:
          type: string
          enum:
            - api_key
            - session
          example: api_key
  responses:
    UnauthorizedError:
      description: Unauthorized - missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error: Invalid or expired API key
            data: null
    NotFoundError:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            error: Resource not found
            data: null
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: |
        API key authentication. Generate keys from your account settings.

        Include in header: `Authorization: Bearer YOUR_API_KEY`

````