GroundTruth

Groundtruth Reporting API

Read-only external reporting API (the "demand" API) for pulling GroundTruth campaign performance out of the platform and into a partner or agency reporting stack: account, organization, campaign, ad group and creative totals and daily series, product-level breakdowns, location and secondary-visit location data, audience and behavioral segments, web engagement, and CTV/OTT and audio metrics. 59 GET operations described by an OpenAPI 3.0.1 document, fronted by AWS API Gateway. Authenticated with the same paired X-GT-USER-ID and X-GT-API-KEY headers; credentials are requested from GroundTruth support. The provider notes that all endpoints currently require HTTP/1.1.

GitHub OpenAPI

Documentation

📖
Documentation
https://reporting.groundtruth.com/api
📖
APIReference
https://reporting.groundtruth.com/api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/groundtruth/refs/heads/main/authentication/groundtruth-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/groundtruth/refs/heads/main/openapi/groundtruth-reporting-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/groundtruth/refs/heads/main/overlays/groundtruth-reporting-overlay.yaml

OpenAPI Specification

groundtruth-reporting-openapi.yml Raw ↑ 
components:
  schemas:
    DailyAdgroup:
      properties:
        account_name:
          type: string
        adgroup_id:
          type: integer
        adgroup_name:
          type: string
        campaign_id:
          type: integer
        campaign_name:
          type: string
        click_to_call:
          type: number
        clicks:
          type: integer
        coupon:
          type: number
        cpm:
          type: number
        creative_id:
          nullable: true
          type: integer
        creative_name:
          nullable: true
          type: string
        ctr:
          type: number
        cumulative_reach:
          type: integer
        daily_reach:
          type: integer
        date:
          type: string
        directions:
          type: number
        impressions:
          type: integer
        moreinfo:
          type: number
        oh_visitors:
          type: number
        oh_vst:
          type: number
        prj_vst:
          type: number
        sar:
          type: number
        spend:
          type: number
        svl:
          type: number
        svr:
          type: number
        total_sa:
          type: number
        video:
          type: number
        video_end:
          type: number
        video_first_quartile:
          type: number
        video_midpoint:
          type: number
        video_start:
          type: number
        video_third_quartile:
          type: number
        visitors:
          type: number
        visits:
          type: integer
        website:
          type: number
      type: object
    DailyCampaign:
      properties:
        date:
          type: string
        cumulative_reach:
          type: number
        adgroup_id:
          type: number
          nullable: true
        adgroup_start_date:
          type: string
          nullable: true
        adgroup_end_date:
          type: string
          nullable: true
        adgroup_status:
          type: string
          nullable: true
        prj_vst:
          type: number
        video_start:
          type: number
        click_to_call:
          type: number
        video:
          type: number
        campaign_name:
          type: string
        visits:
          type: number
        daily_reach:
          type: number
        video_third_quartile:
          type: number
        account_name:
          type: string
        spend:
          type: number
        campaign_id:
          type: number
        video_first_quartile:
          type: number
        ctr:
          type: number
        cpm:
          type: number
        oh_vst:
          type: number
        website:
          type: number
        coupon:
          type: number
        sar:
          type: number
        svl:
          type: number
        video_midpoint:
          type: number
        impressions:
          type: number
        svr:
          type: number
        video_end:
          type: number
        visitors:
          type: number
        oh_visitors:
          type: number
        directions:
          type: number
        clicks:
          type: number
        adgroup_name:
          type: string
          nullable: true
        total_sa:
          type: number
        moreinfo:
          type: number
        campaign_start_date:
          type: string
        campaign_end_date:
          type: string
        adv_bid_type:
          type: string
        budget_type:
          type: string
      type: object
    TotalsAccount:
      properties:
        account_name:
          type: string
        campaign_id:
          type: integer
        campaign_name:
          type: string
        click_to_call:
          type: number
        clicks:
          type: integer
        coupon:
          type: number
        cpm:
          type: number
        ctr:
          type: number
        cumulative_reach:
          type: integer
        cumulative_visitors:
          type: number
        directions:
          type: number
        impressions:
          type: integer
        moreinfo:
          type: number
        open_hour_cumulative_visitors:
          type: number
        open_hour_visits:
          type: number
        projected_open_hour_visits:
          type: number
        projected_visits:
          type: number
        sar:
          type: number
        spend:
          type: number
        svr:
          type: number
        total_sa:
          type: number
        video:
          type: number
        video_end:
          type: number
        video_first_quartile:
          type: number
        video_midpoint:
          type: number
        video_start:
          type: number
        video_third_quartile:
          type: number
        visits:
          type: integer
        website:
          type: number
      type: object
    TotalsAdgroup:
      properties:
        account_name:
          type: string
        adgroup_id:
          type: integer
        adgroup_name:
          type: string
        campaign_id:
          type: integer
        campaign_name:
          type: string
        click_conversions:
          type: number
        click_to_call:
          type: number
        clicks:
          type: integer
        coupon:
          type: number
        cpm:
          type: number
        creative_id:
          nullable: true
          type: integer
        creative_name:
          nullable: true
          type: string
        ctr:
          type: number
        cumulative_reach:
          type: integer
        cumulative_visitors:
          type: integer
        directions:
          type: number
        impressions:
          type: integer
        moreinfo:
          type: number
        open_hour_cumulative_visitors:
          type: integer
        open_hour_visits:
          type: integer
        projected_open_hour_visits:
          type: integer
        projected_visits:
          type: integer
        sar:
          type: number
        spend:
          type: number
        svr:
          type: number
        total_conversions:
          type: number
        total_sa:
          type: number
        video:
          type: number
        video_end:
          type: integer
        video_first_quartile:
          type: integer
        video_midpoint:
          type: integer
        video_start:
          type: integer
        video_third_quartile:
          type: integer
        view_conversions:
          type: number
        visits:
          type: integer
        website:
          type: number
        adgroup_budget:
          type: number
        adgroup_imp_contracted:
          type: number
      type: object
    TotalsCampaign:
      properties:
        account_name:
          type: string
        adgroup_id:
          nullable: true
          type: integer
        adgroup_name:
          nullable: true
          type: string
        campaign_id:
          type: integer
        campaign_name:
          type: string
        click_conversions:
          type: number
        click_to_call:
          type: number
        clicks:
          type: integer
        coupon:
          type: number
        cpm:
          type: number
        creative_id:
          nullable: true
          type: integer
        creative_name:
          nullable: true
          type: string
        ctr:
          type: number
        cumulative_reach:
          type: integer
        cumulative_visitors:
          type: number
        directions:
          type: number
        impressions:
          type: integer
        moreinfo:
          type: number
        open_hour_cumulative_visitors:
          type: number
        open_hour_visits:
          type: integer
        projected_open_hour_visits:
          type: number
        projected_visits:
          type: number
        sar:
          type: number
        spend:
          type: number
        svr:
          type: number
        total_conversions:
          type: number
        total_sa:
          type: number
        video:
          type: number
        video_end:
          type: number
        video_first_quartile:
          type: number
        video_midpoint:
          type: number
        video_start:
          type: number
        video_third_quartile:
          type: number
        view_conversions:
          type: number
        visits:
          type: integer
        website:
          type: number
      type: object
    ProductExportCampaign:
      properties:
        product_group:
          type: string
        product:
          type: string
        constraint:
          type: string
        campaign_id:
          type: number
        campaign_name:
          type: string
        poi_name:
          type: string
        dma_name:
          type: string
        address:
          type: string
        city:
          type: string
        state:
          type: string
        zip:
          type: string
        country:
          type: string
        latitude:
          type: string
        longitude:
          type: string
        imp:
          type: number
        clks:
          type: number
        sa:
          type: number
        spt:
          type: number
        vst:
          type: number
        oh_vst:
          type: number
        ctr:
          type: number
        sar:
          type: number
        vr:
          type: number
        prj_vst:
          type: number
        prj_oh_vst:
          type: number
        web:
          type: number
        dir:
          type: number
        ctc:
          type: number
        info:
          type: number
        cpn:
          type: number
        vid_0:
          type: number
        vid_25:
          type: number
        vid_50:
          type: number
        vid_75:
          type: number
        vid_100:
          type: number
      type: object
    ProductExportAdgroup:
      properties:
        product_group:
          type: string
        product:
          type: string
        constraint:
          type: string
        adgroup_id:
          type: number
        adgroup_name:
          type: string
        poi_name:
          type: string
        dma_name:
          type: string
        address:
          type: string
        city:
          type: string
        state:
          type: string
        zip:
          type: string
        country:
          type: string
        latitude:
          type: string
        longitude:
          type: string
        imp:
          type: number
        clks:
          type: number
        sa:
          type: number
        spt:
          type: number
        vst:
          type: number
        oh_vst:
          type: number
        ctr:
          type: number
        sar:
          type: number
        vr:
          type: number
        prj_vst:
          type: number
        prj_oh_vst:
          type: number
        web:
          type: number
        dir:
          type: number
        ctc:
          type: number
        info:
          type: number
        cpn:
          type: number
        vid_0:
          type: number
        vid_25:
          type: number
        vid_50:
          type: number
        vid_75:
          type: number
        vid_100:
          type: number
      type: object
    ProductExportCreative:
      properties:
        organization_name:
          type: string
        account_id:
          type: number
        account_name:
          type: string
        campaign_id:
          type: number
        campaign_name:
          type: string
        adgroup_id:
          type: number
        adgroup_name:
          type: string
        product_group:
          type: string
        product:
          type: string
        constraint:
          type: string
        creative_id:
          type: number
        creative_name:
          type: string
        poi_name:
          type: string
        dma_name:
          type: string
        address:
          type: string
        city:
          type: string
        state:
          type: string
        zip:
          type: string
        country:
          type: string
        latitude:
          type: string
        longitude:
          type: string
        imp:
          type: number
        clks:
          type: number
        sa:
          type: number
        spt:
          type: number
        vst:
          type: number
        oh_vst:
          type: number
        ctr:
          type: number
        sar:
          type: number
        vr:
          type: number
        prj_vst:
          type: number
        prj_oh_vst:
          type: number
        web:
          type: number
        dir:
          type: number
        ctc:
          type: number
        info:
          type: number
        cpn:
          type: number
        vid_0:
          type: number
        vid_25:
          type: number
        vid_50:
          type: number
        vid_75:
          type: number
        vid_100:
          type: number
      type: object
    TotalsOrg:
      properties:
        account_name:
          type: string
        campaign_id:
          type: number
        account_id:
          type: number
        campaign_name:
          type: string
        account_timezone:
          type: string
        currency:
          type: string
        account_status:
          type: string
        impressions:
          type: number
        clicks:
          type: number
        spend:
          type: number
        ctr:
          type: number
        cpm:
          type: number
        total_sa:
          type: number
        sar:
          type: number
        click_to_call:
          type: number
        directions:
          type: number
        website:
          type: number
        moreinfo:
          type: number
        coupon:
          type: number
        video:
          type: number
        cumulative_reach:
          type: number
        visits:
          type: number
        svr:
          type: number
        video_start:
          type: number
        video_first_quartile:
          type: number
        video_midpoint:
          type: number
        video_third_quartile:
          type: number
        video_end:
          type: number
      type: object
    LocationCampaign:
      properties:
        account_name:
          type: string
        campaign_id:
          type: number
        campaign_name:
          type: string
        zip:
          type: string
          nullable: true
        latitude:
          type: number
          nullable: true
        longitude:
          type: number
          nullable: true
        dma:
          type: integer
          nullable: true
        city:
          type: string
          nullable: true
        state:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        impressions:
          type: number
        clicks:
          type: number
        spend:
          type: number
        ctr:
          type: number
        secondary_actions:
          type: number
        visits:
          type: number
        coupon:
          type: number
        website:
          type: number
        moreinfo:
          type: number
        directions:
          type: number
        click_to_call:
          type: number
      type: object
    LocationAdgroup:
      properties:
        campaign_id:
          type: number
        campaign_name:
          type: string
        adgroup_id:
          type: number
        adgroup_name:
          type: string
        zip:
          type: string
          nullable: true
        latitude:
          type: number
          nullable: true
        longitude:
          type: number
          nullable: true
        dma:
          type: number
          nullable: true
        city:
          type: string
          nullable: true
        state:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        impressions:
          type: number
        clicks:
          type: number
        spend:
          type: number
        ctr:
          type: number
        secondary_actions:
          type: number
        visits:
          type: number
      type: object
    SVLocationCampaign:
      properties:
        campaign_id:
          type: number
        campaign_name:
          type: string
        poi_id:
          type: string
          nullable: true
        company_name:
          type: string
          nullable: true
        address:
          type: string
          nullable: true
        zip:
          type: string
          nullable: true
        dma:
          type: number
          nullable: true
        city:
          type: string
          nullable: true
        state:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        latitude:
          type: number
          nullable: true
        longitude:
          type: number
          nullable: true
        total_sv:
          type: number
      type: object
    SVLocationAdgroup:
      properties:
        campaign_id:
          type: number
        campaign_name:
          type: string
        adgroup_id:
          type: number
        adgroup_name:
          type: string
        poi_id:
          type: string
          nullable: true
        company_name:
          type: string
          nullable: true
        address:
          type: string
          nullable: true
        zip:
          type: string
          nullable: true
        dma:
          type: number
          nullable: true
        city:
          type: string
          nullable: true
        state:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        latitude:
          type: number
          nullable: true
        longitude:
          type: number
          nullable: true
        total_sv:
          type: number
      type: object
    AccountCount:
      properties:
        organization_id:
          type: number
        organization_name:
          type: string
        number_of_accounts:
          type: number
      type: object
    ConversionTracking:
      properties:
        account_name:
          type: string
        account_id:
          type: number
        campaign_id:
          type: number
        campaign_name:
          type: string
        adgroup_id:
          type: number
        adgroup_name:
          type: string
        conversions:
          type: number
        pixel_id:
          type: number
        pixel_name:
          type: string
        view_thru_conversions:
          type: number
        click_thru_conversions:
          type: number
      type: object
    DailyExportCreatives:
      properties:
        date:
          type: string
        organization_name:
          type: string
        account_id:
          type: number
        account_name:
          type: string
        campaign_id:
          type: number
        campaign_name:
          type: string
        adgroup_id:
          type: number
        adgroup_name:
          type: string
        creative_id:
          type: number
        creative_name:
          type: string
        creative_size:
          type: string
        creative_url:
          type: string
        campaign_start_date:
          type: string
        campaign_end_date:
          type: string
        advertiser_bid_type:
          type: string
        budget_type:
          type: string
        impressions:
          type: number
        clicks:
          type: number
        daily_reach:
          type: number
        ctr:
          type: number
        cpm:
          type: number
        cpv:
          type: number
        visits:
          type: number
        video_start:
          type: number
        video_first_quartile:
          type: number
        video_midpoint:
          type: number
        video_third_quartile:
          type: number
        video_end:
          type: number
        total_sa:
          type: number
        coupon:
          type: number
        website:
          type: number
        moreinfo:
          type: number
        directions:
          type: number
        click_to_call:
          type: number
        sar:
          type: number
        spend:
          type: number
        market:
          type: string
        contract_id:
          type: string
        campaign_budget:
          type: number
        total_imp_contracted:
          type: number
        external_adgroup_id:
          type: number
        oh_vst:
          type: number
        prj_vst:
          type: number
      type: object
    BehavioralAudienceCampaign:
      properties:
        a_id:
          type: number
          description: audience_id
        a_name:
          type: string
          description: audience_name
        campaign_id:
          type: number
        campaign_name:
          type: string
        imp:
          type: number
          description: impressions
        vst:
          type: number
          description: visits
        oh_vst:
          type: number
          description: open_hour_visits
        clks:
          type: number
          description: clicks
        ctr:
          type: number
          description: click_thru_rate
        sa:
          type: number
          description: secondary_actions
        sar:
          type: number
          description: secondary_action_rate
        vr:
          type: number
          description: visitation_rate
        prj_vst:
          type: number
          description: projected_visits
        prj_oh_vst:
          type: number
          description: projected_open_hour_visits
      type: object
    BehavioralAudienceAdgroup:
      properties:
        a_id:
          type: number
          description: audience_id
        a_name:
          type: string
          description: audience_name
        adgroup_id:
          type: number
        adgroup_name:
          type: string
        imp:
          type: number
          description: impressions
        vst:
          type: number
          description: visits
        oh_vst:
          type: number
          description: open_hour_visits
        clks:
          type: number
          description: clicks
        ctr:
          type: number
          description: click_thru_rate
        sa:
          type: number
          description: secondary_actions
        sar:
          type: number
          description: secondary_action_rate
        vr:
          type: number
          description: visitation_rate
        prj_vst:
          type: number
          description: projected_visits
        prj_oh_vst:
          type: number
          description: projected_open_hour_visits
      type: object
    BehavioralAudienceCreative:
      properties:
        a_id:
          type: number
          description: audience_id
        a_name:
          type: string
          description: audience_name
        creative_id:
          type: number
        creative_name:
          type: string
        imp:
          type: number
          description: impressions
        vst:
          type: number
          description: visits
        oh_vst:
          type: number
          description: open_hour_visits
        clks:
          type: number
          description: clicks
        ctr:
          type: number
          description: click_thru_rate
        sa:
          type: number
          description: secondary_actions
        sar:
          type: number
          description: secondary_action_rate
        vr:
          type: number
          description: visitation_rate
        prj_vst:
          type: number
          description: projected_visits
        prj_oh_vst:
          type: number
          description: projected_open_hour_visits
      type: object
    CategoryCampaign:
      properties:
        sic:
          type: string
          description: category_id
        c_name:
          type: string
          description: category_name
        campaign_id:
          type: number
        campaign_name:
          type: string
        imp:
          type: number
          description: impressions
        vst:
          type: number
          description: visits
        oh_vst:
          type: number
          description: open_hour_visits
        clks:
          type: number
          description: clicks
        ctr:
          type: number
          description: click_thru_rate
        sa:
          type: number
          description: secondary_actions
        sar:
          type: number
          description: secondary_action_rate
        vr:
          type: number
          description: visitation_rate
        prj_vst:
          type: number
          description: projected_visits
        prj_oh_vst:
          type: number
          description: projected_open_hour_visits
      type: object
    CategoryAdgroup:
      properties:
        sic:
          type: string
          description: category_id
        c_name:
          type: string
          description: category_name
        adgroup_id:
          type: number
        adgroup_name:
          type: string
        imp:
          type: number
          description: impressions
        vst:
          type: number
          description: visits
        oh_vst:
          type: number
          description: open_hour_visits
        clks:
          type: number
          description: clicks
        ctr:
          type: number
          description: click_thru_rate
        sa:
          type: number
          description: secondary_actions
        sar:
          type: number
          description: secondary_action_rate
        vr:
          type: number
          description: visitation_rate
        prj_vst:
          type: number
          description: projected_visits
        prj_oh_vst:
          type: number
          description: projected_open_hour_visits
      type: object
    CategoryCreative:
      properties:
        sic:
          type: string
          description: category_id
        c_name:
          type: string
          description: category_name
        creative_id:
          type: number
        creative_name:
          type: string
        imp:
          type: number
          description: impressions
        vst:
          type: number
          description: visits
        oh_vst:
          type: number
          description: open_hour_visits
        clks:
          type: number
          description: clicks
        ctr:
          type: number
          description: click_thru_rate
        sa:
          type: number
          description: secondary_actions
        sar:
          type: number
          description: secondary_action_rate
        vr:
          type: number
          description: visitation_rate
        prj_vst:
          type: number
          description: projected_visits
        prj_oh_vst:
          type: number
          description: projected_open_hour_visits
      type: object
    BrandAffinityCampaign:
      properties:
        b_id:
          type: number
          description: brand_id
        b_name:
          type: string
          description: brand_name
        campaign_id:
          type: number
        campaign_name:
          type: string
        imp:
          type: number
          description: impressions
        vst:
          type: number
          description: visits
        oh_vst:
          type: number
          description: open_hour_visits
        clks:
          type: number
          description: clicks
        ctr:
          type: number
          description: click_thru_rate
        sa:
          type: number
          description: secondary_actions
        sar:
          type: number
          description: secondary_action_rate
        vr:
          type: number
          description: visitation_rate
        prj_vst:
          type: number
          description: projected_visits
        prj_oh_vst:
          type: number
          description: projected_open_hour_visits
      type: object
    BrandAffinityAdgroup:
      properties:
        b_id:
          type: number
          description: brand_id
        b_name:
          type: string
          description: brand_name
        adgroup_id:
          type: number
        adgroup_name:
          type: string
        imp:
          type: number
          description: impressions
        vst:
          type: number
          description: visits
        oh_vst:
          type: number
          description: open_hour_visits
        clks:
          type: number
          description: clicks
        ctr:
          type: number
          description: click_thru_rate
        sa:
          type: number
          description: secondary_actions
        sar:
          type: number
          description: secondary_action_rate
        vr:
          type: number
          description: visitation_rate
        prj_vst:
          type: number
          description: projected_visits
        prj_oh_vst:
          type: number
          description: projected_open_hour_visits
      type: object
    BrandAffinityCreative:
      properties:
        b_id:
          type: number
          description: brand_id
        b_name:
          type: string
          description: brand_name
        creative_id:
          type: number
        creative_name:
          type: string
        imp:
          type: number
          description: impressions
        vst:
          type: number
          description: visits
        oh_vst:
          type: number
          description: open_hour_visits
        clks:
          type: number
          description: clicks
        ctr:
          type: number
          description: click_thru_rate
        sa:
          type: number
          description: secondary_actions
        sar:
          type: number
          description: secondary_action_rate
        vr:
          type: number
          description: visitation_rate
        prj_vst:
          type: number
          description: projected_visits
        prj_oh_vst:
          type: number
          description: projected_open_hour_visits
      type: object
    DemographicCampaign:
      properties:
        account_name:
          type: string
        campaign_id:
          type: number
        campaign_name:
          type: string
        adgroup_id:
          nullable: true
          type: number
        adgroup_name:
          nullable: true
          type: string
        age:
          nullable: true
          type: string
        gender:
          nullable: true
          type: string
        impressions:
          type: number
        clicks:
          type: number
        spend:
          type: number
        ctr:
          type: number
          description: click_thru_rate
        cpm:
          type: number
        total_sa:
          type: number
        sar:
          type: number
          description: secondary_action_rate
        click_to_call:
          type: number
        directions:
          type: number
        website:
          type: number
        moreinfo:
          type: number
        coupon:
          type: number
        video:
          type: number
        cumulative_reach:
          type: number
        visits:
          type: number
        open_hour_visits:
          type: number
        projected_visits:
          type: number
        projected_open_hour_visits:
          type: number
      type: object
    DeviceTypeCampaign:
      properties:
        account_name:
          type: string
        campaign_id:
          type: number
        campaign_name:
          type: string
        pub_type:
          type: string
          description: device_type
        impressions:
          type: number
        clicks:
          type: number
        spend:
          type: number
        ctr:
          type: number
          description: click_thru_rate
      type: object
    DeviceTypeAdgroup:
      properties:
        account_name:
          type: string
        campaign_id:
          type: number
        campaign_name:
          type: string
        adgroup_id:
          type: number
        adgroup_name:
          type: string
        pub_type:
          type: string
          description: device_type
        impressions:
          type: number
        clicks:
          type: number
        spend:
          type: number
        ctr:
          type: number
          description: click_thru_rate
      type: object
    ProductExportCampaignV2:
      properties:
        product_group:
          type: str

# --- truncated at 32 KB (162 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/groundtruth/refs/heads/main/openapi/groundtruth-reporting-openapi.yml