EmailOctopus · OpenAPI Overlay 1.0.0

API Evangelist enhancements for EmailOctopus Campaign API

8 actions 8 updates documentation extends openapi/emailoctopus-campaign-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for EmailOctopus's API. It is a proposal applied on top of the contract, not a document EmailOctopus publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-operation-idx-apievangelist-tagx-apievangelist-providerx-apievangelist-artifactsx-apievangelist-harvestcontacttermsOfServicex-apievangelist-conventions

Targets 7

$.info
$.servers[0]
$.paths['/campaigns'].get
$.paths['/campaigns/{campaign_id}'].get
$.paths['/campaigns/{campaign_id}/reports'].get
$.paths['/campaigns/{campaign_id}/reports/links'].get
$.paths['/campaigns/{campaign_id}/reports/summary'].get

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for EmailOctopus Campaign API
  version: 1.0.0
extends: openapi/emailoctopus-campaign-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: openapi/emailoctopus-campaign-api-openapi.yml + repo artifacts
actions:
- target: $.info
  update:
    x-apievangelist-provider: emailoctopus
    x-apievangelist-artifacts:
      authentication: authentication/emailoctopus-authentication.yml
      conventions: conventions/emailoctopus-conventions.yml
      errors: errors/emailoctopus-problem-types.yml
      rate-limits: rate-limits/emailoctopus-rate-limits.yml
      data-model: data-model/emailoctopus-data-model.yml
      webhooks: asyncapi/emailoctopus-webhooks.yml
      lifecycle: lifecycle/emailoctopus-lifecycle.yml
    x-apievangelist-harvest:
      source: https://emailoctopus.com/api-documentation/v2
      fetched: '2026-08-13'
      note: Split by tag from the provider-published OpenAPI 3.1.0; operationIds are the provider's own.
    contact:
      name: EmailOctopus Support
      url: https://help.emailoctopus.com
    termsOfService: https://emailoctopus.com/legal/terms
- target: $.info
  update:
    x-apievangelist-conventions:
      pagination:
        style: cursor
        params:
        - limit
        - starting_after
        max_page_size: 100
        collection_field: data
        cursor_field: paging.next.starting_after
      idempotency:
        supported: false
        note: No Idempotency-Key contract. PUT upserts are the only safe-retry path.
      errors:
        format: rfc7807
        media_type: application/json
        type_uri_prefix: https://emailoctopus.com/api-documentation/v2#
      rate_limit:
        algorithm: token-bucket
        bucket: 100
        refill_per_second: 10
        remaining_header: X-RateLimiting-Remaining
        retry_header: X-RateLimit-Retry-After
        exhausted_status: 429
- target: $.servers[0]
  update:
    description: EmailOctopus v2 production API. No version segment in the path; version is bound to the API key.
- target: $.paths['/campaigns'].get
  update:
    x-apievangelist-operation-id: api_campaigns_get
    x-apievangelist-tag: Campaign
- target: $.paths['/campaigns/{campaign_id}'].get
  update:
    x-apievangelist-operation-id: api_campaigns_campaign_id_get
    x-apievangelist-tag: Campaign
- target: $.paths['/campaigns/{campaign_id}/reports'].get
  update:
    x-apievangelist-operation-id: api_campaigns_campaign_idreports_get
    x-apievangelist-tag: Campaign
- target: $.paths['/campaigns/{campaign_id}/reports/links'].get
  update:
    x-apievangelist-operation-id: api_campaigns_campaign_idreportslinks_get
    x-apievangelist-tag: Campaign
- target: $.paths['/campaigns/{campaign_id}/reports/summary'].get
  update:
    x-apievangelist-operation-id: api_campaigns_campaign_idreportssummary_get
    x-apievangelist-tag: Campaign