Request OpenAPI specs for Marketing API and Conversions API

Open
#3 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Quiet
Tech stack
openapi
Domain
api

Research direction

The issue names no existing files, tests, or entry points. Start by reviewing the repository's current specifications and coverage, then determine how versioned Marketing API and Conversions API definitions should be organized. Done means publishing accurate specs with the requested endpoints, schemas, security details, and examples, but the scope requires design decisions before implementation.

Written by the indexing model from the issue text.

Description

This was generated by AI during triage.

Request

Please consider publishing official OpenAPI specifications for the Meta Marketing API and Conversions API in this repository.

APIs requested

  • Marketing API, including common Ads Management and Insights endpoints
  • Conversions API, including event submission endpoints and related request/response schemas

Why this would help

Official OpenAPI specs would make it much easier for developers and partners to:

  • generate typed clients and SDK integrations consistently across languages
  • validate request payloads before sending traffic to production APIs
  • keep integrations aligned with versioned API changes
  • build better internal tooling, mocks, tests, and documentation from a trusted source
  • reduce ambiguity around required fields, enum values, nested objects, and error responses

Suggested scope

A useful first version could include:

  • versioned specs matching currently supported Marketing API versions
  • endpoint paths, methods, parameters, request bodies, and response schemas
  • authentication/security scheme details
  • reusable schemas for ads, campaigns, ad sets, insights, pixels, events, user data, and error responses
  • examples for common workflows such as campaign management, insights reporting, and Conversions API event uploads

Even partial coverage for the highest-usage endpoints would be valuable if complete coverage needs to be phased in.

Dominant language
No language data
Stars
179
Forks
61
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from facebook/openapi

All issues in facebook/openapi

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.