Matomo

Matomo Advertising Conversion Export API

Exposes API endpoints for managing advertising conversion export configurations. These methods let users list, inspect, create, update, and delete configured exports and access tokens.

GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /index.php?module=API&method=AdvertisingConversionExport.getConversionExports List advertising conversion exports · Advertising conversion export get conversion exports #
Ask an LLM
“Which ad conversion exports have been set up for my sites?”
“Can I list conversion exports for just one website?”
Tell an agent
List all advertising conversion exports I can manage.
Show the conversion exports configured for site {idSite}.
GET /index.php?module=API&method=AdvertisingConversionExport.getConversionExport Get one conversion export's configuration · Advertising conversion export get conversion export #
Ask an LLM
“What settings does a specific conversion export use?”
“How is one of my ad conversion exports configured?”
Tell an agent
Get the configuration of conversion export {idExport}.
Show the stored settings for export {idExport}.
GET /index.php?module=API&method=AdvertisingConversionExport.deleteConversionExport Delete a conversion export · Advertising conversion export delete conversion export #
Ask an LLM
“How do I remove an ad conversion export I no longer need?”
“Does deleting a conversion export also clear its cached file?”
Tell an agent destructive · confirm first
Delete conversion export {idExport} on site {idSite}.
Remove export {idExport} from site {idSite} and clear its cached output.
GET /index.php?module=API&method=AdvertisingConversionExport.addConversionExport Create an advertising conversion export · Advertising conversion export add conversion export #
Ask an LLM
“How do I set up an export of conversions to upload to an ad platform?”
“Can I give a new conversion export a name and description?”
Tell an agent
Create a {type} conversion export named {name} for site {idSite} with parameters {parameters}.
Add a new conversion export {name} of type {type} on site {idSite} using {parameters}, described as {description}.
GET /index.php?module=API&method=AdvertisingConversionExport.regenerateAccessToken Regenerate a conversion export's access token · Advertising conversion export regenerate access token #
Ask an LLM
“How do I invalidate the download link for a conversion export?”
“Can I issue a new access token for downloading an export?”
Tell an agent destructive · confirm first
Regenerate the access token for conversion export {idExport}.
Issue a new download token for export {idExport}, replacing the old one.
GET /index.php?module=API&method=AdvertisingConversionExport.updateConversionExport Update a conversion export · Advertising conversion export update conversion export #
Ask an LLM
“How do I change the parameters of an existing conversion export?”
“Can I rename a conversion export I already created?”
Tell an agent
Update existing export {idExport} on site {idSite}: name {name}, type {type}, parameters {parameters}.
Edit conversion export {idExport} on site {idSite} to use parameters {parameters}, keeping name {name} and type {type}.

Documentation

📖
Documentation
https://developer.matomo.org/api-reference/reporting-api
📖
Documentation
https://developer.matomo.org/api-reference/reporting-api#Live
📖
Documentation
https://developer.matomo.org/api-reference/reporting-api#Goals
📖
Documentation
https://developer.matomo.org/api-reference/reporting-api-segmentation

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/openapi/matomo-advertisingconversionexport-api-openapi.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/matomo:matomo-advertisingconversionexport-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

matomo-advertisingconversionexport-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Matomo Reporting API for plugin Advertising Conversion…
  version: 1.0.0
  description: Exposes API endpoints for managing advertising conversion export configurations. These methods let users list, inspect, create, update, and delete configured exports and access tokens.
servers:
- url: https://demo-proxy.innocraft.cloud/
  description: Current Matomo instance
security:
- MatomoToken: []
tags:
- name: AdvertisingConversionExport
  description: Exposes API endpoints for managing advertising conversion export configurations. These methods let users list, inspect, create, update, and delete configured exports and access tokens.
paths:
  /index.php?module=API&method=AdvertisingConversionExport.getConversionExports:
    get:
      tags:
      - AdvertisingConversionExport
      description: Returns configured conversion exports for one site or for every site the current user can manage.
      operationId: AdvertisingConversionExport.getConversionExports
      parameters:
      - $ref: '#/components/parameters/formatOptional'
      - name: idSite
        in: query
        description: The numeric ID of the website to query. When omitted, exports for all sites with write access are returned.
        required: false
        schema:
          oneOf:
          - type: integer
          - type: string
      responses:
        '200':
          description: 'The configured conversion exports keyed by numeric array index.


            Example responses require Super User access. Use Try it out to see a live response.'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Advertising conversion export get conversion exports
      x-summary-source: derived
  /index.php?module=API&method=AdvertisingConversionExport.getConversionExport:
    get:
      tags:
      - AdvertisingConversionExport
      description: Returns the stored configuration for a specific conversion export.
      operationId: AdvertisingConversionExport.getConversionExport
      parameters:
      - $ref: '#/components/parameters/formatOptional'
      - name: idExport
        in: query
        description: The numeric ID of the conversion export to load.
        required: true
        schema:
          type: integer
          example: 7
      responses:
        '200':
          description: 'The stored conversion export configuration.


            Example responses require Super User access. Use Try it out to see a live response.'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Advertising conversion export get conversion export
      x-summary-source: derived
  /index.php?module=API&method=AdvertisingConversionExport.deleteConversionExport:
    get:
      tags:
      - AdvertisingConversionExport
      description: Deletes a configured conversion export and clears its cached output.
      operationId: AdvertisingConversionExport.deleteConversionExport
      parameters:
      - $ref: '#/components/parameters/formatOptional'
      - name: idExport
        in: query
        description: The numeric ID of the conversion export to delete.
        required: true
        schema:
          type: integer
          example: 7
      - name: idSite
        in: query
        description: The numeric ID of the website that owns the export.
        required: true
        schema:
          type: integer
          example: 1
      responses:
        '200':
          $ref: '#/components/responses/GenericSuccess'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Advertising conversion export delete conversion export
      x-summary-source: derived
  /index.php?module=API&method=AdvertisingConversionExport.addConversionExport:
    get:
      tags:
      - AdvertisingConversionExport
      description: Creates a new advertising conversion export configuration.
      operationId: AdvertisingConversionExport.addConversionExport
      parameters:
      - $ref: '#/components/parameters/formatOptional'
      - name: idSite
        in: query
        description: The numeric ID of the website the export belongs to.
        required: true
        schema:
          type: integer
          example: 1
      - name: name
        in: query
        description: The export name shown in the Matomo UI.
        required: true
        schema:
          type: string
          example: Pricing
      - name: type
        in: query
        description: The export type ID, for example `GoogleAds`, `MicrosoftAds`, or `YandexAds`.
        required: true
        schema:
          type: string
          example: html
      - name: parameters
        in: query
        description: Export settings including selected goals, export windows, attribution options, and an optional segment filter.
        required: true
        schema:
          oneOf:
          - type: string
          - type: integer
      - name: description
        in: query
        description: A free-text description for the export.
        required: false
        schema:
          type: string
          default: ''
      responses:
        '200':
          description: 'The created export ID and its newly generated access token.


            Example responses require Super User access. Use Try it out to see a live response.'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Advertising conversion export add conversion export
      x-summary-source: derived
  /index.php?module=API&method=AdvertisingConversionExport.regenerateAccessToken:
    get:
      tags:
      - AdvertisingConversionExport
      description: Regenerates the access token used to download a conversion export.
      operationId: AdvertisingConversionExport.regenerateAccessToken
      parameters:
      - $ref: '#/components/parameters/formatOptional'
      - name: idExport
        in: query
        description: The numeric ID of the conversion export to update.
        required: true
        schema:
          type: integer
          example: 7
      responses:
        '200':
          description: 'The newly generated access token.


            Example responses require Super User access. Use Try it out to see a live response.'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Advertising conversion export regenerate access token
      x-summary-source: derived
  /index.php?module=API&method=AdvertisingConversionExport.updateConversionExport:
    get:
      tags:
      - AdvertisingConversionExport
      description: Updates an existing advertising conversion export configuration.
      operationId: AdvertisingConversionExport.updateConversionExport
      parameters:
      - $ref: '#/components/parameters/formatOptional'
      - name: idExport
        in: query
        description: The numeric ID of the conversion export to update.
        required: true
        schema:
          type: integer
          example: 7
      - name: idSite
        in: query
        description: The numeric ID of the website that owns the export.
        required: true
        schema:
          type: integer
          example: 1
      - name: name
        in: query
        description: The updated export name shown in the Matomo UI.
        required: true
        schema:
          type: string
          example: Pricing
      - name: type
        in: query
        description: The updated export type ID, for example `GoogleAds`, `MicrosoftAds`, or `YandexAds`.
        required: true
        schema:
          type: string
          example: html
      - name: parameters
        in: query
        description: Updated export settings including selected goals, export windows, attribution options, and an optional segment filter.
        required: true
        schema:
          oneOf:
          - type: string
          - type: integer
      - name: description
        in: query
        description: The updated free-text description for the export.
        required: false
        schema:
          type: string
          default: ''
      responses:
        '200':
          $ref: '#/components/responses/GenericSuccess'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Advertising conversion export update conversion export
      x-summary-source: derived
components:
  responses:
    Forbidden:
      description: Authenticated but not allowed to access the resource.
      content:
        text/plain:
          schema:
            type: string
          example: 'Error: Not authorised.'
        text/html:
          schema:
            type: string
          example: Not authorised.
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorXml'
    BadRequest:
      description: Bad request (validation or missing parameters).
      content:
        text/plain:
          schema:
            type: string
          example: 'Error: There was an error.'
        text/html:
          schema:
            type: string
          example: There was an error.
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorXml'
    GenericSuccess:
      description: Generic 200 response
      content:
        text/plain:
          schema:
            type: string
          example: Success:ok
        text/html:
          schema:
            type: string
          example: '<!-- Success: ok -->'
        application/json:
          schema:
            $ref: '#/components/schemas/GenericSuccess'
        application/xml:
          schema:
            $ref: '#/components/schemas/GenericSuccessXml'
    NotFound:
      description: Resource not found.
      content:
        text/plain:
          schema:
            type: string
          example: 'Error: The method is not available.'
        text/html:
          schema:
            type: string
          example: The method is not available.
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorXml'
    Unauthorized:
      description: Authentication failed or missing token.
      content:
        text/plain:
          schema:
            type: string
          example: 'Error: You must be logged in to access this functionality.'
        text/html:
          schema:
            type: string
          example: You must be logged in to access this functionality.
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorXml'
    ServerError:
      description: Unexpected server error.
      content:
        text/plain:
          schema:
            type: string
          example: 'Error: There was an error.'
        text/html:
          schema:
            type: string
          example: There was an error.
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorXml'
    DefaultError:
      description: Default error response (any non-2xx).
      content:
        text/plain:
          schema:
            type: string
          example: 'Error: There was an error.'
        text/html:
          schema:
            type: string
          example: There was an error.
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
        application/xml:
          schema:
            $ref: '#/components/schemas/ErrorXml'
  schemas:
    ErrorXml:
      description: Generic Matomo error payload in XML.
      properties:
        error:
          properties:
            message:
              type: string
              xml:
                attribute: true
              example: There was an error
          type: object
          xml:
            name: error
      type: object
      xml:
        name: result
    Error:
      description: Generic Matomo error payload.
      required:
      - result
      - message
      properties:
        result:
          type: string
          example: error
        message:
          type: string
          example: There was an error
        code:
          type: integer
      type: object
      additionalProperties: true
    GenericSuccess:
      description: Generic Matomo success payload.
      required:
      - result
      - message
      properties:
        result:
          type: string
          example: success
        message:
          type: string
          example: ok
        code:
          type: integer
          example: '200'
      type: object
      example:
        result: success
        message: ok
      additionalProperties: true
    GenericSuccessXml:
      description: Generic Matomo success payload in XML.
      required:
      - success
      properties:
        success:
          properties:
            message:
              type: string
              xml:
                attribute: true
              example: ok
          type: object
          xml:
            name: success
      type: object
      xml:
        name: result
      example:
        success:
          message: ok
      additionalProperties: true
  parameters:
    formatOptional:
      name: format
      in: query
      description: Response format. Defaults to `xml`. Use `original` to get the original PHP data structure.
      required: false
      schema:
        type: string
        default: xml
        enum:
        - xml
        - json
        - csv
        - tsv
        - html
        - rss
        - original
  securitySchemes:
    MatomoToken:
      type: http
      description: Paste your token generated from Personal > Security. Swagger will send it as a Bearer token.
      scheme: bearer
externalDocs:
  description: Matomo Reporting API developer page
  url: https://developer.matomo.org/api-reference/reporting-api/