Hitsteps API

openapi: 3.1.0
info:
  title: Hitsteps API
  version: '2026-11-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-11: 4 operation(s) read from 5 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Hitsteps has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 1
    pages-with-code: 4
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.hitsteps.com/api
  - https://www.hitsteps.com/api/reports-guide.html
  - https://www.hitsteps.com/api/reports-api-quickstart.html
  - https://www.hitsteps.com/guide/api-and-connectors
  - https://www.hitsteps.com/support.php
paths:
  /api/callback-doc:
    get:
      operationId: get_api_callback_doc
      tags:
      - Api
      summary: GET /api/callback-doc
      x-source: https://www.hitsteps.com/guide/api-and-connectors
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl, Python, PHP and n8n examples. \n Analytics API reference : https://www.hitsteps.com/api/callback-doc renders the interactive\
          \ reference; the machine-readable spec is at https://www.hitsteps.com/api/callback.oas2 . \n Grafana setup : https://www.hitsteps.com/grafana-integration/with\
          \ the importable dashboard JSON at https://www.hitsteps.com/api/hitsteps-grafana-dashboard.json . \n Looker Studio co"
  /api/callback/{action}:
    post:
      operationId: post_api_callback_action
      tags:
      - Api
      summary: Analytics API endpoint for various actions.
      description: The request body is `multipart/form-data`. Authentication uses the API code form field.
      x-source: https://www.hitsteps.com/api
      parameters:
      - name: action
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiCallbackActionRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/reports-v2.php:
    get:
      operationId: get_api_reports_v2_php
      tags:
      - Api
      summary: GET /api/reports-v2.php
      x-source: https://www.hitsteps.com/api/reports-guide.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl, Python and n8n examples right away? Try the Reports API quickstart . \n Start a free Hitsteps account \n See analytics\
          \ features \n English reference · Updated November 6, 2026 \n Get a key Make a request Choose dates PHP example Read the response Errors\
          \ and limits Keep access safe \n 1. Save your report and create a key \n Open your website in Hitsteps, go to Reports , and save the\
          \ report you want"
    post:
      operationId: post_api_reports_v2_php
      tags:
      - Api
      summary: POST /api/reports-v2.php
      x-source: https://www.hitsteps.com/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiReportsV2PhpRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --silent --show-error --include  'https://www.hitsteps.com/api/reports-v2.php'  -H @-  -H 'Content-Type: application/json'\
          \  --data '{\"from\":1788645600,\"until\":1788732000}' \n Those two timestamps are 6 and 7 September 2026 for an account at UTC+02:00.\
          \ --include prints the status line and headers, so you can see a Retry-After value when the rate limit answers. Always branch on the\
          \ HTTP status: "
components:
  schemas:
    PostApiCallbackActionRequest:
      type: object
      properties:
        apicode:
          type: string
          description: API code credential (form field).
        website_id:
          type: string
          description: Website identifier for most actions.
      required:
      - apicode
    PostApiReportsV2PhpRequest:
      type: object
      properties:
        from:
          type: integer
        until:
          type: integer
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      x-source: https://www.hitsteps.com/mac-menubar-setup/
tags:
- name: Api
security:
- Bearer: []