LoopMe · OpenAPI Overlay 1.0.0

API Evangelist enhancements for the LoopMe Advertiser Reporting API

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

What the actions change

x-apievangelist-artifactsx-error-envelopex-rate-limitsx-idempotencyx-agentic-accessx-error-codesx-entity-hierarchydescription

Targets 3

$.info
$.paths['/reports/campaigns'].get
$.tags[?(@.name=='Advertiser Reporting')]

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for the LoopMe Advertiser Reporting API
  version: 1.0.0
extends: openapi/loopme-advertiser-reporting-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: >-
  Enhancements derived from https://wiki.loopme.cool/publishers/reporting-api and
  the artifacts in this repo. Never applied to the harvested spec; the original
  stays at openapi/_original/loopme-reporting-openapi.yml.
actions:
  - target: $.info
    update:
      x-apievangelist-artifacts:
        authentication: authentication/loopme-authentication.yml
        conventions: conventions/loopme-conventions.yml
        errors: errors/loopme-error-codes.yml
        data_model: data-model/loopme-data-model.yml
        rate_limits: rate-limits/loopme-rate-limits.yml
        lifecycle: lifecycle/loopme-lifecycle.yml
      x-error-envelope:
        shape: '{ "errors": { "<code>": "<description>" } }'
        multi_error: true
        catalog: errors/loopme-error-codes.yml
      x-rate-limits:
        documented: false
        ref: rate-limits/loopme-rate-limits.yml
      x-idempotency:
        supported: false
        reason: Read-only GET surface; no idempotency key is documented.
  - target: $.paths['/reports/campaigns'].get
    update:
      x-agentic-access:
        action-class: connected
        consequence: read
      x-error-codes: [1001, 2001, 2002, 2003, 3001, 4002, 4003, 4004, 5001, 6001]
      x-entity-hierarchy:
        ref: data-model/loopme-data-model.yml
        relationships:
          - Campaign has_many LineItem via campaign_id
          - LineItem has_many Creative via line_item_id
  - target: $.tags[?(@.name=='Advertiser Reporting')]
    update:
      description: >-
        Campaign, line item and creative performance statistics for LoopMe
        advertiser accounts.
      externalDocs:
        url: https://wiki.loopme.cool/publishers/reporting-api