Finance API

This page covers the methods and endpoints associated with finance operations. With the Finance API you can access and manage PLD, SLS, and AQS fees.

Type	Vertical
VLD (Voter Level Data)	Political vertical
PLD (Provider Level Data)	Healthcare vertical
SLS (Script Lift Study)	Healthcare vertical
AQS (Audience Quality Score)	Healthcare vertical
ICT (Integrated Care Team)	Healthcare vertical
NLD (Nurse Level Data)	Both Political and Healthcare verticals

More Resources

• Insights API Guidelines
• Add or manage a margin Help Center article

Authentication

Use the following header parameters for all requests:

Headers
Authentication string required	Authentication bearer token See Authentication Guide
X-IAA-OW-ID integer required	Organization Workspace ID Header

Finance Details

Get Customer Insights Fees Details

GET

Get insight fees details for a Customer. If type is provided, fetches for that specific report type; otherwise, fetches for all types.

Path Parameters
customerOwId integer	Customer Organization Workspace ID

Query Parameters
type string optional	Insight report type, supported values: vld, pld, sls, aqs, ict, nld If not provided, returns all applicable types for the Customer's vertical

Response Properties

owId integer	Customer Organization Workspace ID
categories object	Map of insight category names to their fee details
categories object properties rate number Rate for the insight report enabled boolean Whether the category is enabled markupType string Markup type: "Absolute" or "Percentage" markupTypeId integer Markup type ID markupValue number Markup value

JSON

ResponseAll Categories

Response 200

{
    "success": true,
    "data": {
        "owId": 201427,
        "categories": {
            "nld": {
                "rate": 5.5,
                "enabled": true,
                "markupType": "Percentage",
                "markupTypeId": 2,
                "markupValue": 55.5
            },
            "ict": {
                "rate": 5.5,
                "enabled": true,
                "markupType": "Percentage",
                "markupTypeId": 2,
                "markupValue": 55.5
            },
            "pld": {
                "rate": 5.5,
                "enabled": true,
                "markupType": "Percentage",
                "markupTypeId": 2,
                "markupValue": 55.5
            },
            "vld": {
                "rate": 5.5,
                "enabled": true,
                "markupType": "Percentage",
                "markupTypeId": 2,
                "markupValue": 55.5
            },
            "sls": {
                "rate": 5.5,
                "enabled": true,
                "markupType": "Percentage",
                "markupTypeId": 2,
                "markupValue": 55.5
            },
            "aqs": {
                "rate": 5.5,
                "enabled": true,
                "markupType": "Percentage",
                "markupTypeId": 2,
                "markupValue": 55.5
            }
        }
    }
}

TypeScript

See TypeScript Prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface InsightCategoryDetails {
  rate: number;
  enabled: boolean;
  markupType: string;
  markupTypeId: number;
  markupValue: number;
}

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          owId: number;
          categories: Record<string, InsightCategoryDetails>;
        }
      }
    };
  };
}

function getInsightFees(): Promise<Responses> {
  const options = {
    method: 'GET',
    url: 'https://api.iqm.com/api/v3/fa/customer/{customerOwId}/insight-fees',
    params: {
      path: {
        customerOwId: `number`
      },
      query: {
        type: `string`
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}

---

Update Customer Insights Fees Details

PATCH

Update insight fees for a specific category for a Customer.

Path Parameters
customerOwId integer	Customer Organization Workspace ID

Request Schema
category string required	Insight report type category. Valid values: pld, vld, ict, sls, aqs, nld
rate number	Rate for the insight report
enabled boolean	Enable or disable the report
markupType string	Markup type: Absolute or Percentage
markupTypeId integer	Markup type ID
markupValue number	Markup value

Response Properties

id integer	Updated record ID
message string	Success message

JSON

Request Sample

{
    "category": "pld",
    "rate": 11,
    "enabled": true,
    "markupType": "Percentage",
    "markupTypeId": 2,
    "markupValue": 55.5
}

ResponseRate UpdatedInsights Enabled

Response 200

{
    "success": true,
    "data": {
        "id": 1,
        "message": "Rate updated successfully. The new rate applies only to newly created reports"
    }
}

Response 200

{
    "success": true,
    "data": {
        "id": 6,
        "message": "Insights enabled successfully."
    }
}

TypeScript

See TypeScript Prerequisites for usage.

import {
  getInstance
} from "prerequisites"

const axios = getInstance();

interface Responses {
  200: {
    headers: {
      [name: string]: unknown;
    };
    content: {
      "application/json": {
        success: boolean;
        data: {
          id: number;
          message: string;
        }
      }
    };
  };
}

function updateInsightFees(): Promise<Responses> {
  const options = {
    method: 'PATCH',
    url: 'https://api.iqm.com/api/v3/fa/customer/{customerOwId}/insight-fees',
    params: {
      path: {
        customerOwId: `number`
      }
    },
    requestBody: {
      content: {
        "application/json": {
          category: `string`,
          rate?: `number`,
          enabled?: `boolean`,
          markupType?: `string`,
          markupTypeId?: `number`,
          markupValue?: `number`,
        }
      }
    }
  };

  return axios.request(options).then(({ data }: { data: Responses }) => data);
}