OwnLocal

OwnLocal Reports Data API

Performance reporting for ads and businesses — impressions, interaction breakdowns, leads, digital lift and search-rank history.

GitHub OpenAPI

Operations 2

GET /api/v1/reports/ads Builds and returns an ads report #
GET /api/v1/reports/business Builds and returns a business report #

Documentation

📖
Documentation
https://api.docs.ownlocal.com/
📖
APIReference
https://api.docs.ownlocal.com/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/ownlocal/refs/heads/main/authentication/ownlocal-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/ownlocal/refs/heads/main/rate-limits/ownlocal-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ownlocal/refs/heads/main/openapi/ownlocal-reports-data-api-api-openapi.yml

Other Resources

🔗
Swagger
https://admin.austin.ownlocal.com/api-docs/v1/swagger.json
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/ownlocal/refs/heads/main/conventions/ownlocal-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/ownlocal/refs/heads/main/data-model/ownlocal-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/ownlocal/refs/heads/main/errors/ownlocal-problem-types.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/ownlocal/refs/heads/main/mcp/ownlocal-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ownlocal-reports-data-api-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ownlocal-reports-data-api-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OwnLocal API — Reports Data Reports Data API
  version: v1
  description: Performance reporting for ads and businesses — impressions, interaction breakdowns, leads, digital lift and search-rank history.
  contact:
    name: OwnLocal Support
    email: support@ownlocal.com
    url: https://www.ownlocal.com/support/
servers:
- url: https://admin.austin.ownlocal.com
  description: OwnLocal production API host (per the published API reference)
security:
- apiKey: []
tags:
- name: Reports Data API
  description: Performance reporting for ads and businesses — impressions, interaction breakdowns, leads, digital lift and search-rank history.
paths:
  /api/v1/reports/ads:
    get:
      tags:
      - Reports Data API
      summary: Builds and returns an ads report
      operationId: getAdsReport
      parameters:
      - name: publisher_id
        in: query
        required: false
        schema:
          type: string
        example: 7f188b7b-7bc8-452e-9bb6-82bb3e13f4b1
      - name: start_date
        in: query
        required: false
        schema:
          type: string
        example: '2020-02-01'
      - name: end_date
        in: query
        required: false
        schema:
          type: string
        example: '2020-02-02'
      responses:
        '200':
          description: result ads report
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ads_report'
      security:
      - apiKey: []
  /api/v1/reports/business:
    get:
      tags:
      - Reports Data API
      summary: Builds and returns a business report
      operationId: getBusinessReport
      parameters:
      - name: publisher_id
        in: query
        required: false
        schema:
          type: string
        example: 7f188b7b-7bc8-452e-9bb6-82bb3e13f4b1
      - name: business_id
        in: query
        required: false
        schema:
          type: string
        example: d69b6855-7e24-47e1-96a0-11c55ca0e9a7
      - name: start_date
        in: query
        required: false
        schema:
          type: string
        example: '2020-02-01'
      - name: end_date
        in: query
        required: false
        schema:
          type: string
        example: '2020-02-02'
      responses:
        '200':
          description: result business report
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/business_report'
      security:
      - apiKey: []
components:
  schemas:
    business_report:
      type: object
      properties:
        start_date:
          type: string
          example: '2020-06-01'
          format: date
        end_date:
          type: string
          example: '2020-07-01'
          format: date
        business_name:
          type: string
          example: My Local Business
          format: string
        business_id:
          type: string
          example: 2db5e240-c098-4d59-b3a3-bc7b7abc2c4c
          format: uuid
        reach_report:
          type: object
          items:
            type: object
            description: 'Unconstrained: the OwnLocal source Swagger references ''#/definitions/business_reach'' but never defines it. Shape is only knowable from the response example.'
            x-ownlocal-unresolved-ref: '#/definitions/business_reach'
          example:
            print_distribution: 0
            online_impressions:
              overall: 277160
            total_ads: 13
            directory:
              days: 31
              impressions: 0
            origami:
              ads: 9
              days: 10
              impressions:
                overall: 277160
            interaction_breakdown:
              breakdowns:
                overall:
                  total_clicks: 209
                  about_us_clicks: 1
                  contact_clicks: 0
                  expand_ad_unit_clicks: 181
                  print_ad_clicks: 0
                  website_clicks: 19
                  facebook_clicks: 0
                  twitter_clicks: 0
                  instagram_clicks: 0
                  yelp_clicks: 0
                  call_clicks: 1
                  directions_clicks: 7
                  contact_form_submits: 0
                  share: 0
    ads_report:
      type: object
      properties:
        start_date:
          type: string
          example: '2020-06-01'
          format: date
        end_date:
          type: string
          example: '2020-07-01'
          format: date
        publisher_name:
          type: string
          example: The Pub News
          format: string
        publisher_id:
          type: string
          example: 2db5e240-c098-4d59-b3a3-bc7b7abc2c4c
          format: uuid
        ads:
          type: array
          items:
            type: object
            description: 'Unconstrained: the OwnLocal source Swagger references ''#/definitions/ad_reach'' but never defines it. Shape is only knowable from the response example.'
            x-ownlocal-unresolved-ref: '#/definitions/ad_reach'
          example:
          - uuid: 87415afa-ac85-4f55-b869-c63532d02ffe
            start_date: '2020-06-24'
            end_date: '2020-06-25'
            data:
              online_impressions:
                overall: 11346
              interaction_breakdown:
                breakdowns:
                  overall:
                    total_clicks: 9
                    about_us_clicks: 0
                    contact_clicks: 0
                    expand_ad_unit_clicks: 9
                    print_ad_clicks: 0
                    website_clicks: 0
                    facebook_clicks: 0
                    twitter_clicks: 0
                    instagram_clicks: 0
                    yelp_clicks: 0
                    call_clicks: 0
                    directions_clicks: 0
                    contact_form_submits: 0
                    share: 0
          - uuid: a3c6f485-07b1-4241-9bc7-9945be77d0a5
            data:
              online_impressions:
                overall: 11410
              interaction_breakdown:
                breakdowns:
                  overall:
                    total_clicks: 4
                    about_us_clicks: 0
                    contact_clicks: 0
                    expand_ad_unit_clicks: 4
                    print_ad_clicks: 0
                    website_clicks: 0
                    facebook_clicks: 0
                    twitter_clicks: 0
                    instagram_clicks: 0
                    yelp_clicks: 0
                    call_clicks: 0
                    directions_clicks: 0
                    contact_form_submits: 0
                    share: 0
  securitySchemes:
    apiKey:
      type: apiKey
      name: Authorization
      in: header
      description: Organization API key sent raw (no scheme prefix) in the Authorization header. Keys are issued by OwnLocal support; there is no self-serve key provisioning.
externalDocs:
  description: OwnLocal API Docs
  url: https://api.docs.ownlocal.com/