MixRank · OpenAPI Overlay 1.0.0

API Evangelist enhancements for MixRank Data API

6 actions 6 updates documentation extends openapi/mixrank-openapi.yml
Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.
View Overlay File View on GitHub Overlay Specification

What the actions change

nameinrequiredschemadescriptionx-apievangelist-enrichedx-authenticationx-conventions

Targets 3

$.info
$.paths['/email/prospect'].get.parameters
$.paths['/email/validate'].get.parameters

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for MixRank Data API
  version: 1.0.0
extends: openapi/mixrank-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-enriched: '2026-07-20'
    x-authentication: authentication/mixrank-authentication.yml
    x-conventions: conventions/mixrank-conventions.yml
    x-error-catalog: errors/mixrank-problem-types.yml
    x-lifecycle: lifecycle/mixrank-lifecycle.yml
    x-data-model: data-model/mixrank-data-model.yml
- target: $.info
  update:
    x-datasets:
    - Company (Enrich/Match) — 45M+ profiles
    - People — 800M+ profiles
    - Mobile Apps & SDKs — 20M+ iOS/Android apps
    - Web Technographics — 80M+ websites
- target: $.info
  update:
    x-pagination:
      style: offset
      params: [offset, page_size, sort_field, sort_order]
    x-async-jobs:
      pattern: job
      resources: [email/validate/bulk-job, companies/segment-query, person/segment-query]
- target: $.info
  update:
    x-examples: examples/mixrank-examples.yml
    x-webhooks: asyncapi/mixrank-webhooks.yml
    x-packages: packages/mixrank-packages.yml
    x-well-known: well-known/mixrank-well-known.yml
    x-webhook-callbacks:
      standard: Standard Webhooks
      parameter: webhook
      operations: [prospectEmail, validateEmail]
      acknowledgement_status: 202
      signature_header: Webhook-Signature
      note: >-
        Documented at https://mixrank.com/api/documentation but absent from the
        harvested spec. Captured as an overlay enhancement rather than written
        into the OpenAPI, which stays as harvested.
- target: $.paths['/email/prospect'].get.parameters
  description: >-
    MixRank documents a `webhook` query parameter on this operation that the
    harvested spec omits; supplying it makes the call asynchronous.
  update:
    name: webhook
    in: query
    required: false
    schema:
      type: string
      format: uri
    description: >-
      An https url to deliver the result to. Given one, the request is accepted
      with a 202 and a body of {"id": ..., "status": "accepted"} instead of
      waiting for the prospecting. The result is POSTed to this url as soon as
      it is ready, as a Standard Webhooks delivery.
- target: $.paths['/email/validate'].get.parameters
  description: >-
    MixRank documents a `webhook` query parameter on this operation that the
    harvested spec omits; supplying it makes the call asynchronous.
  update:
    name: webhook
    in: query
    required: false
    schema:
      type: string
      format: uri
    description: >-
      An https url to deliver the result to. Given one, the request is accepted
      with a 202 and a body of {"id": ..., "status": "accepted"} instead of
      waiting for the validation. The result is POSTed to this url as soon as it
      is ready, as a Standard Webhooks delivery.