> ## Documentation Index
> Fetch the complete documentation index at: https://developer.instantly.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get conversions summary

> Counts the conversions in a UTC date range per attribution, optionally split by the last email's journey, journey step or broadcast, or by the group value.


Requires one of the following scopes: `email_marketing_conversions:read`, `email_marketing_conversions:all`, `all:read`, `all:all`



## OpenAPI

````yaml https://api.instantly.ai/openapi/api_v2.json get /api/v2/email-marketing/conversions/summary
openapi: 3.1.0
info:
  title: API Explorer
  description: >-
    The entire API V2 documentation is interactive and can be tested here. To
    the right side of every endpoint you will see a box with an example request.
    You can click on the "Try it" button to send a request to the server right
    from the docs. You will need to provide an API key by clicking the
    `ApiKeyAuth_token` blue text.
  version: 2.0.0
servers:
  - url: https://api.instantly.ai
    description: Instantly API Server
security:
  - ApiKeyAuth: []
tags:
  - name: Analytics
    description: Endpoints related to analytics
    x-group: Analytics
  - name: OAuth
    description: >-
      OAuth authentication endpoints for connecting Google and Microsoft email
      accounts
    x-group: OAuth
  - name: Account
    description: An email account that can be used to send campaigns
    x-group: Account
  - name: Campaign
    description: A campaign that can be sent to a list of recipients
    x-group: Campaign
  - name: Email
    description: >-
      A campaign email, a reply, a manually sent email, or any other email
      that's visible in the Unibox
    x-group: Email
  - name: EmailVerification
    description: A single email verification
    x-group: Email Verification
  - name: LeadList
    description: A list used to store leads
    x-group: Lead List
  - name: InboxPlacementTest
    description: An inbox placement test
    x-group: Inbox Placement Test
  - name: InboxPlacementAnalytics
    description: Analytics data for individual emails in inbox placement tests
    x-group: Inbox Placement Analytics
  - name: InboxPlacementBlacklistAndSpamAssassinReport
    description: Report data for an inbox placement test
    x-group: Inbox Placement Blacklist And SpamAssassin Report
  - name: AIInboxManager
    description: An AI Inbox Manager agent
    x-group: AI Inbox Manager
  - name: AIDeliverabilityAgent
    description: An AI Deliverability Agent
    x-group: AI Deliverability Agent
  - name: AILeadFinderAgent
    description: An AI Lead Finder Agent
    x-group: AI Lead Finder Agent
  - name: LocalBusiness
    description: >-
      A local business found by the Local businesses search. Search businesses
      by category and location, then convert them into leads with a verified
      email in a lead list or a campaign.
    x-group: Local Business
  - name: Creator
    description: >-
      A social media creator found by the Creators search. Search creators by
      platform, niche, audience and location, then convert them into leads with
      their email.
    x-group: Creator
  - name: APIKey
    description: API Key
    x-group: API Key
  - name: AccountCampaignMapping
    description: Account Campaign Mapping
    x-group: Account Campaign Mapping
  - name: Lead
    description: A lead entity representing an individual lead
    x-group: Lead
  - name: BackgroundJob
    description: A background job that can be used to perform long-running tasks
    x-group: Background Job
  - name: CustomTag
    description: >-
      A custom tag for organizing and categorizing accounts and campaigns. You
      can use them as filters in apis that list accounts and campaigns.
    x-group: Custom Tag
  - name: CustomTagMapping
    description: >-
      This entity represents a tag being assigned to a specific campaign or
      email account. When an email account is assigned a tag, a new custom tag
      mapping entry is created, which connects the tag (`tag_id` field) with the
      email account (`resource_id` field). You can use it to see which tag si
      connected to which resource.
    x-group: Custom Tag Mapping
  - name: BlockListEntry
    description: A blocked email or domain
    x-group: Block List Entry
  - name: LeadLabel
    description: A custom label for categorizing and managing leads
    x-group: Lead Label
  - name: Workspace
    description: A workspace entity representing a workspace
    x-group: Workspace
  - name: SuperSearchEnrichment
    description: >-
      An enrichment can take different forms, such as email enrichment or
      LinkedIn enrichment. Leads may be imported from SuperSearch using the
      dedicated endpoint, or enriched directly within a list or campaign by
      attaching an enrichment to it.
    x-group: SuperSearch Enrichment
  - name: WorkspaceGroupMember
    description: >-
      A member of a workspace group. You can use the endpoints within this
      entity to manage the members of a workspace group.
    x-group: Workspace Group Member
  - name: WorkspaceMember
    description: A member of a workspace with associated user details
    x-group: Workspace Member
  - name: CampaignSubsequence
    description: A subsequence entity representing a follow-up sequence
    x-group: Campaign Subsequence
  - name: AuditLog
    description: Audit log records for tracking system activities
    x-group: Audit Log
  - name: AISalesAgent
    description: >-
      An AI Sales Development Representative that autonomously manages outreach
      campaigns
    x-group: AI Sales Agent
  - name: Webhook
    description: A webhook subscription for receiving event notifications
    x-group: Webhook
  - name: WebhookEvent
    description: A webhook event that was sent or attempted to be sent
    x-group: Webhook Event
  - name: DFYEmailAccountOrder
    description: A Done-For-You email account order
    x-group: DFY Email Account Order
  - name: DomainForwarding
    description: Web forwarding configuration for a domain ordered through Instantly
    x-group: Domain Forwarding
  - name: CustomPromptTemplate
    description: Custom prompt templates for creating custom prompts
    x-group: Custom Prompt Template
  - name: SalesFlow
    description: >-
      Manages how sales users view and interact with campaign and lead lists
      within the sales flow.
    x-group: Sales Flow
  - name: EmailTemplate
    description: A campaign email template
    x-group: Email Template
  - name: WorkspaceBilling
    description: Workspace Billing
    x-group: Workspace Billing
  - name: CRMActions
    description: CRM related actions
    x-group: CRM Actions
  - name: Conversion
    description: >-
      A conversion event received for a person, credited to the emails they got
      before it.
    x-group: Conversion
  - name: EngageItem
    description: >-
      A unified Engage item representing a campaign, AI agent, automation
      workflow, broadcast, or journey.
    x-group: Engage Item
paths:
  /api/v2/email-marketing/conversions/summary:
    get:
      tags:
        - Conversion
      summary: Get conversions summary
      description: >-
        Counts the conversions in a UTC date range per attribution, optionally
        split by the last email's journey, journey step or broadcast, or by the
        group value.



        Requires one of the following scopes:
        `email_marketing_conversions:read`, `email_marketing_conversions:all`,
        `all:read`, `all:all`
      operationId: getConversionsSummary
      parameters:
        - schema:
            type: string
            format: date
            example: '2026-08-01'
          example: '2026-08-01'
          in: query
          name: start_date
          required: true
          description: First UTC day of the period (YYYY-MM-DD)
        - schema:
            type: string
            format: date
            example: '2026-08-31'
          example: '2026-08-31'
          in: query
          name: end_date
          required: true
          description: >-
            Last UTC day of the period (YYYY-MM-DD); the period spans at most
            366 days, both ends included
        - schema:
            type: string
            enum:
              - instantly
              - api
              - calendly
              - typeform
              - shopify
              - woocommerce
              - wix
              - jotform
              - intercom
              - pipedrive
              - salesforce
              - hubspot
              - highlevel
              - leadconnector
              - zoho_crm
            example: api
          example: api
          in: query
          name: source
          required: false
          description: Producer of the conversion event
        - schema:
            type: string
            minLength: 2
            maxLength: 60
            pattern: ^[A-Za-z0-9._-]+$
            example: subscription_started
          example: subscription_started
          in: query
          name: event_name
          required: false
          description: Name of the conversion event
        - schema:
            type: string
            enum:
              - journey
              - step
              - broadcast
              - group_value
            example: journey
          example: journey
          in: query
          name: group_by
          required: false
          description: >-
            Split the totals by the last email's journey, journey step or
            broadcast, or by the group value
      responses:
        '200':
          description: The conversion totals
          content:
            application/json:
              schema:
                type: object
                properties:
                  totals:
                    type: object
                    properties:
                      total:
                        type: integer
                        description: All conversions
                        examples:
                          - 12
                        example: 12
                      direct:
                        type: integer
                        description: Clicked an email before converting
                        examples:
                          - 5
                        example: 5
                      influenced:
                        type: integer
                        description: Opened but did not click an email before converting
                        examples:
                          - 4
                        example: 4
                      received:
                        type: integer
                        description: Only received emails before converting
                        examples:
                          - 2
                        example: 2
                      none:
                        type: integer
                        description: Got no email in the lookback window
                        examples:
                          - 1
                        example: 1
                    required:
                      - total
                      - direct
                      - influenced
                      - received
                      - none
                  distinct_people:
                    type: integer
                    description: >-
                      People behind the conversions; absent when the period
                      holds too many conversions to count them
                    examples:
                      - 11
                    example: 11
                  history_incomplete:
                    type: integer
                    description: >-
                      Conversions whose email history was too long to read in
                      full, so an earlier email may be missing
                    examples:
                      - 0
                    example: 0
                  groups:
                    type: array
                    description: >-
                      Totals per group and conversion event, largest first, at
                      most 1000; present only when group_by is set
                    items:
                      type: object
                      properties:
                        total:
                          type: integer
                          description: All conversions
                          examples:
                            - 12
                          example: 12
                        direct:
                          type: integer
                          description: Clicked an email before converting
                          examples:
                            - 5
                          example: 5
                        influenced:
                          type: integer
                          description: Opened but did not click an email before converting
                          examples:
                            - 4
                          example: 4
                        received:
                          type: integer
                          description: Only received emails before converting
                          examples:
                            - 2
                          example: 2
                        none:
                          type: integer
                          description: Got no email in the lookback window
                          examples:
                            - 1
                          example: 1
                        source:
                          type: string
                          examples:
                            - api
                          example: api
                        event_name:
                          type: string
                          examples:
                            - subscription_started
                          example: subscription_started
                        journey_id:
                          type: string
                          examples:
                            - journey-12ab
                          example: journey-12ab
                        version:
                          type: integer
                          examples:
                            - 3
                          example: 3
                        step_id:
                          type: string
                          examples:
                            - step-1
                          example: step-1
                        broadcast_id:
                          type: string
                          examples:
                            - broadcast-42ef
                          example: broadcast-42ef
                        group_value:
                          type: string
                          examples:
                            - starter
                          example: starter
                        journey_name:
                          type: string
                          description: Absent when the journey was deleted
                          examples:
                            - Welcome series
                          example: Welcome series
                        broadcast_name:
                          type: string
                          description: Absent when the broadcast was deleted
                          examples:
                            - August newsletter
                          example: August newsletter
                      required:
                        - total
                        - direct
                        - influenced
                        - received
                        - none
                        - source
                        - event_name
                  groups_truncated:
                    type: boolean
                    description: >-
                      True when more groups exist than were returned; present
                      only when group_by is set
                    examples:
                      - false
                    example: false
                required:
                  - totals
                  - history_incomplete
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    example: 400
                  error:
                    type: string
                    example: Bad Request
                  message:
                    type: string
                    example: 'name: Invalid domain name format'
                  code:
                    type: string
                    example: VALIDATION_ERROR
        '401':
          description: >-
            This request is unauthorized (either the Authorization header is
            missing or invalid, or the API key has been revoked)
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 401
                    examples:
                      - 401
                    example: 401
                  error:
                    type: string
                    enum:
                      - Unauthorized
                    examples:
                      - Unauthorized
                    example: Unauthorized
                  message:
                    type: string
                    examples:
                      - Missing Authorization header
                    example: Missing Authorization header
                required:
                  - statusCode
                  - error
                  - message
        '402':
          description: >-
            This request cannot be fulfilled because the workspace does not have
            an active paid plan
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 402
                    examples:
                      - 402
                    example: 402
                  error:
                    type: string
                    enum:
                      - Payment Required
                    examples:
                      - Payment Required
                    example: Payment Required
                  message:
                    type: string
                    examples:
                      - Workspace does not have an active paid plan
                    example: Workspace does not have an active paid plan
                required:
                  - statusCode
                  - error
                  - message
        '404':
          description: The requested resource was not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 404
                    examples:
                      - 404
                    example: 404
                  error:
                    type: string
                    enum:
                      - Not Found
                    examples:
                      - Not Found
                    example: Not Found
                  message:
                    type: string
                    examples:
                      - Resource not found
                    example: Resource not found
                required:
                  - statusCode
                  - error
                  - message
        '429':
          description: >-
            You have exceeded the rate limit. Please check the rate limit docs
            for more information.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    enum:
                      - 429
                    examples:
                      - 429
                    example: 429
                  error:
                    type: string
                    enum:
                      - Too Many Requests
                    examples:
                      - Too Many Requests
                    example: Too Many Requests
                  message:
                    type: string
                    examples:
                      - Rate limit exceeded
                    example: Rate limit exceeded
                required:
                  - statusCode
                  - error
                  - message
components:
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.