FirstPromoter

FirstPromoter Reports API

The Reports API from FirstPromoter — 7 operation(s) for reports.

Documentation GitHub OpenAPI

Operations 7

GET /reports/overview Get campaigns reports

GET /reports/sub_ids Get sub_ids report

GET /reports/download Download reports

GET /reports/campaigns Get reports for campaigns

GET /reports/promoters Get reports for promoters

GET /reports/traffic_sources Get reports for traffic sources

GET /reports/urls Get reports for URLs

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/firstpromoter-reports-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

openapi: 3.2.0
info:
  title: Firstpromoter Reports API
  version: '1.0'
  description: 'Operations tagged Reports across 2 of this provider''s published API definitions: firstpromoter-v2-affiliate-reports-openapi.yml, firstpromoter-v2-reports-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.firstpromoter.com/api/v2/affiliate
- url: https://api.firstpromoter.com/api/v2/company
security:
- BearerAuth: []
tags:
- name: Reports
paths:
  /reports/overview:
    get:
      summary: Get campaigns reports
      tags:
      - Reports
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: columns
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
            enum:
            - active_customers
            - monthly_churn
            - clicks_count
            - net_revenue_amount
            - revenue_amount
            - referrals_count
            - customers_count
            - sales_count
            - refunds_count
            - cancelled_customers_count
            - promoter_earnings_amount
            - non_link_customers
            - referrals_to_customers_cr
            - 3m_epc
            - 6m_epc
            - clicks_to_customers_cr
            - clicks_to_referrals_cr
            - promoter_paid_amount
            - signups_count
      - name: q
        in: query
        required: false
        schema:
          type: string
      - name: group_by
        in: query
        required: true
        schema:
          type: string
          enum:
          - day
          - week
          - month
          - year
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: sorting
        in: query
        required: false
        schema:
          type: object
          additionalProperties:
            type: string
            enum:
            - asc
            - desc
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReportData'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.firstpromoter.com/api/v2/affiliate
  /reports/sub_ids:
    get:
      summary: Get sub_ids report
      tags:
      - Reports
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: columns
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
            enum:
            - clicks_count
            - revenue_amount
            - promoter_earnings_amount
            - referrals_count
            - customers_count
            - sales_count
            - refunds_count
            - cancelled_customers_count
            - referrals_to_customers_cr
            - clicks_to_customers_cr
            - clicks_to_referrals_cr
      - name: q
        in: query
        required: false
        schema:
          type: string
      - name: group_by
        in: query
        required: true
        schema:
          type: string
          enum:
          - day
          - week
          - month
          - year
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: sorting
        in: query
        required: false
        schema:
          type: object
          additionalProperties:
            type: string
            enum:
            - asc
            - desc
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SubIdReportData'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    servers:
    - url: https://api.firstpromoter.com/api/v2/affiliate
  /reports/download:
    get:
      summary: Download reports
      tags:
      - Reports
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: report_type
        in: query
        required: true
        schema:
          type: string
          enum:
          - overview
          - traffic_sources
          - urls
          - sub_ids
      - name: totals
        in: query
        required: false
        schema:
          type: boolean
      - name: columns
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
      - name: group_by
        in: query
        required: true
        schema:
          type: string
          enum:
          - day
          - week
          - month
          - year
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Successful response
          content:
            text/csv:
              schema:
                type: string
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '422':
          description: Unprocessable Entity
    servers:
    - url: https://api.firstpromoter.com/api/v2/affiliate
  /reports/campaigns:
    get:
      summary: Get reports for campaigns
      description: With this endpoint you can get the report data grouped by campaigns.<Tip>**HTTP Request** <br/>`GET https://api.firstpromoter.com/api/v2/company/reports/campaigns`</Tip>
      tags:
      - Reports
      parameters:
      - $ref: '#/components/parameters/AccountId_2'
      - name: columns
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
            enum:
            - active_customers
            - monthly_churn
            - clicks_count
            - net_revenue_amount
            - revenue_amount
            - referrals_count
            - customers_count
            - sales_count
            - refunds_count
            - cancelled_customers_count
            - promoter_earnings_amount
            - non_link_customers
            - referrals_to_customers_cr
            - 3m_epc
            - 6m_epc
            - clicks_to_customers_cr
            - clicks_to_referrals_cr
            - promoter_paid_amount
            - signups_count
      - name: q
        in: query
        required: false
        schema:
          type: string
      - name: group_by
        in: query
        required: true
        schema:
          type: string
          enum:
          - day
          - week
          - month
          - year
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: sorting
        in: query
        required: false
        schema:
          type: object
          additionalProperties:
            type: string
            enum:
            - asc
            - desc
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    campaign:
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                        color:
                          type: string
                    id:
                      type: integer
                    data:
                      type: object
                      properties:
                        revenue_amount:
                          type: number
                        net_revenue_amount:
                          type: number
                        promoter_earnings_amount:
                          type: number
                        customers_count:
                          type: integer
                        referrals_count:
                          type: integer
                        clicks_count:
                          type: integer
                        active_customers:
                          type: integer
                        3m_epc:
                          type: number
                    sub_data:
                      type: array
                      items:
                        type: object
                        properties:
                          period:
                            type: string
                          id:
                            type: string
                          data:
                            type: object
                            properties:
                              revenue_amount:
                                type: number
                              net_revenue_amount:
                                type: number
                              promoter_earnings_amount:
                                type: number
                              customers_count:
                                type: integer
                              referrals_count:
                                type: integer
                              clicks_count:
                                type: integer
                              active_customers:
                                type: integer
                              3m_epc:
                                type: number
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  code:
                    type: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  code:
                    type: string
    servers:
    - url: https://api.firstpromoter.com/api/v2/company
  /reports/promoters:
    get:
      summary: Get reports for promoters
      description: ' With this endpoint you can get the report data grouped by promoters.<Tip>**HTTP Request** <br/>`GET https://api.firstpromoter.com/api/v2/company/reports/promoters`</Tip>'
      tags:
      - Reports
      parameters:
      - $ref: '#/components/parameters/AccountId_2'
      - name: columns
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
            enum:
            - active_customers
            - monthly_churn
            - clicks_count
            - net_revenue_amount
            - revenue_amount
            - referrals_count
            - customers_count
            - sales_count
            - refunds_count
            - cancelled_customers_count
            - promoter_earnings_amount
            - non_link_customers
            - referrals_to_customers_cr
            - 3m_epc
            - 6m_epc
            - clicks_to_customers_cr
            - clicks_to_referrals_cr
            - promoter_paid_amount
            - signups_count
        description: Fields to be included in the report
      - name: q
        in: query
        required: false
        schema:
          type: string
        description: Search query string
      - name: group_by
        in: query
        required: true
        schema:
          type: string
          enum:
          - day
          - week
          - month
          - year
        description: Time period grouping
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date-time
        description: Start date for the report period
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date-time
        description: End date for the report period
      - name: sorting
        in: query
        required: false
        schema:
          type: object
          additionalProperties:
            type: string
            enum:
            - asc
            - desc
        description: Sorting parameters
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    promoter:
                      type: object
                      properties:
                        id:
                          type: integer
                        email:
                          type: string
                          format: email
                        name:
                          type: string
                      required:
                      - id
                      - email
                      - name
                    id:
                      type: integer
                    data:
                      type: object
                      properties:
                        revenue_amount:
                          type: number
                        net_revenue_amount:
                          type: number
                        promoter_earnings_amount:
                          type: number
                        customers_count:
                          type: integer
                        referrals_count:
                          type: integer
                        clicks_count:
                          type: integer
                        active_customers:
                          type: integer
                        3m_epc:
                          type: number
                    sub_data:
                      type: array
                      items:
                        type: object
                        properties:
                          period:
                            type: string
                          id:
                            type: string
                          data:
                            type: object
                            properties:
                              revenue_amount:
                                type: number
                              net_revenue_amount:
                                type: number
                              promoter_earnings_amount:
                                type: number
                              customers_count:
                                type: integer
                              referrals_count:
                                type: integer
                              clicks_count:
                                type: integer
                              active_customers:
                                type: integer
                              3m_epc:
                                type: number
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Unauthorized
                  code:
                    type: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid user type
                  code:
                    type: string
                    example: forbidden
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: 'param is missing or the value is empty: columns'
                  code:
                    type: string
                    example: invalid_params
    servers:
    - url: https://api.firstpromoter.com/api/v2/company
  /reports/traffic_sources:
    get:
      summary: Get reports for traffic sources
      description: "With this endpoint you can get the report data grouped by traffic sources. \n <Tip>**HTTP Request** <br/>`GET https://api.firstpromoter.com/api/v2/company/reports/traffic_sources`</Tip>"
      tags:
      - Reports
      parameters:
      - $ref: '#/components/parameters/AccountId_2'
      - name: columns
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
            enum:
            - clicks_count
            - revenue_amount
            - promoter_earnings_amount
            - referrals_count
            - customers_count
            - sales_count
            - refunds_count
            - cancelled_customers_count
            - referrals_to_customers_cr
            - clicks_to_customers_cr
            - clicks_to_referrals_cr
        description: Fields to be included in the report
      - name: q
        in: query
        required: false
        schema:
          type: string
        description: Search query string
      - name: group_by
        in: query
        required: true
        schema:
          type: string
          enum:
          - day
          - week
          - month
          - year
        description: Time period grouping
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date-time
        description: Start date for the report period
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date-time
        description: End date for the report period
      - name: sorting
        in: query
        required: false
        schema:
          type: object
          additionalProperties:
            type: string
            enum:
            - asc
            - desc
        description: Sorting parameters
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    source:
                      type: string
                    id:
                      type: string
                    data:
                      type: object
                      properties:
                        clicks_count:
                          type: integer
                        revenue_amount:
                          type: number
                        promoter_earnings_amount:
                          type: number
                        referrals_count:
                          type: integer
                        customers_count:
                          type: integer
                        sales_count:
                          type: integer
                        refunds_count:
                          type: integer
                        cancelled_customers_count:
                          type: integer
                        referrals_to_customers_cr:
                          type: number
                        clicks_to_customers_cr:
                          type: number
                        clicks_to_referrals_cr:
                          type: number
                    sub_data:
                      type: array
                      items:
                        type: object
                        properties:
                          period:
                            type: string
                          id:
                            type: string
                          data:
                            type: object
                            properties:
                              clicks_count:
                                type: integer
                              revenue_amount:
                                type: number
                              promoter_earnings_amount:
                                type: number
                              referrals_count:
                                type: integer
                              customers_count:
                                type: integer
                              sales_count:
                                type: integer
                              refunds_count:
                                type: integer
                              cancelled_customers_count:
                                type: integer
                              referrals_to_customers_cr:
                                type: number
                              clicks_to_customers_cr:
                                type: number
                              clicks_to_referrals_cr:
                                type: number
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Unauthorized
                  code:
                    type: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid user type
                  code:
                    type: string
                    example: forbidden
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: 'param is missing or the value is empty: columns'
                  code:
                    type: string
                    example: invalid_params
    servers:
    - url: https://api.firstpromoter.com/api/v2/company
  /reports/urls:
    get:
      summary: Get reports for URLs
      description: With this endpoint you can get the report data grouped by URLs.<Tip>**HTTP Request** <br/>`GET https://api.firstpromoter.com/api/v2/company/reports/urls`</Tip>
      tags:
      - Reports
      parameters:
      - $ref: '#/components/parameters/AccountId_2'
      - name: columns
        in: query
        required: true
        schema:
          type: array
          items:
            type: string
            enum:
            - clicks_count
            - revenue_amount
            - promoter_earnings_amount
            - referrals_count
            - customers_count
            - sales_count
            - refunds_count
            - cancelled_customers_count
            - referrals_to_customers_cr
            - clicks_to_customers_cr
            - clicks_to_referrals_cr
            - url
      - name: q
        in: query
        required: false
        schema:
          type: string
      - name: group_by
        in: query
        required: true
        schema:
          type: string
          enum:
          - day
          - week
          - month
          - year
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: sorting
        in: query
        required: false
        schema:
          type: object
          additionalProperties:
            type: string
            enum:
            - asc
            - desc
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/URLsResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '422':
          description: Unprocessable Entity
    servers:
    - url: https://api.firstpromoter.com/api/v2/company
components:
  schemas:
    Error:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
      required:
      - message
      - code
    SubIdReportData:
      type: object
      properties:
        sub_id:
          type: string
        id:
          type: string
        data:
          type: object
          properties:
            clicks_count:
              type: integer
            revenue_amount:
              type: number
            promoter_earnings_amount:
              type: number
            referrals_count:
              type: integer
            customers_count:
              type: integer
            sales_count:
              type: integer
            refunds_count:
              type: integer
            cancelled_customers_count:
              type: integer
            referrals_to_customers_cr:
              type: number
            clicks_to_customers_cr:
              type: number
            clicks_to_referrals_cr:
              type: number
        sub_data:
          type: array
          items:
            type: object
            properties:
              period:
                type: string
              id:
                type: string
              data:
                $ref: '#/components/schemas/SubIdReportData/properties/data'
    ReportData:
      type: object
      properties:
        period:
          type: string
        id:
          type: string
        data:
          type: object
          properties:
            revenue_amount:
              type: number
            net_revenue_amount:
              type: number
            promoter_earnings_amount:
              type: number
            customers_count:
              type: integer
            referrals_count:
              type: integer
            clicks_count:
              type: integer
            active_customers:
              type: integer
            3m_epc:
              type: number
    URLsResponse:
      type: array
      items:
        type: object
        properties:
          url:
            type: string
          id:
            type: string
          data:
            type: object
            properties:
              clicks_count:
                type: integer
              revenue_amount:
                type: number
              promoter_earnings_amount:
                type: number
              referrals_count:
                type: integer
              customers_count:
                type: integer
              sales_count:
                type: integer
              refunds_count:
                type: integer
              cancelled_customers_count:
                type: integer
              referrals_to_customers_cr:
                type: number
              clicks_to_customers_cr:
                type: number
              clicks_to_referrals_cr:
                type: number
  parameters:
    AccountId:
      name: Account-ID
      in: header
      required: true
      description: Account identifier that specifies which account is making the request
      schema:
        type: string
        example: acc_123456
    AccountId_2:
      name: Account-ID
      in: header
      required: true
      description: Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations
      schema:
        type: string
        example: acc_123456
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Access token passed as a Bearer token in the Authorization header
    accountId:
      type: apiKey
      in: header
      name: ACCOUNT-ID
      description: Account ID required with bearer token
x-refined-from:
- firstpromoter-v2-affiliate-reports-openapi.yml
- firstpromoter-v2-reports-openapi.yml