Impact
API integration

list_all_impact_company_information

Retrieve the current profile and account metadata for your impact.com partner account. Returns: Description, Currency, Uri, openapi, info, tags, servers, security, components, paths.

impact_company_information_bulk_update

Update your impact.com partner account information; only provided parameters are changed while others remain unchanged. Returns: Status, Uri, openapi, info, tags, servers, security, components, paths. Required: ContentInterests, Description, LogoImage. FinancialContact, TechnicalContact, and CommercialContact cannot be updated via the API and must be changed in the impact.com UI.

list_all_impact_actions

List conversion actions attributed to your partner account in impact.com, ordered by creation date (newest first). Returns: Id, CampaignId, CampaignName, ActionTrackerId, ActionTrackerName, State, AdId, Payout, Amount, Currency, EventDate, LockingDate, Oid, EventCode, SharedId, SubId1, SubId2, SubId3, DeltaPayout, IntendedPayout, DeltaAmount, IntendedAmount, ReferringDate, CreationDate,…

get_single_impact_action_by_id

Get a single conversion action by id in impact.com. Returns: Id, openapi, info, tags, servers, paths. Required: id.

list_all_impact_action_items

List all items within a specific action in impact.com, in the order they were recorded. Each action has at least one item. Returns: Sku, ItemName, Category, Quantity, SaleAmount, SaleAmountCurrency, Payout, PayoutCurrency, Rebate, RebateCurrency, AdjustmentDate, AdjustmentReason, Uri. Required: action_id.

get_single_impact_action_item_by_id

Retrieve a specific item within an action in impact.com by its SKU. Returns: Uri, openapi, info, tags, servers, paths, components. Required: action_id, id.

list_all_impact_action_updates

List action updates in impact.com, useful for syncing action state changes with internal systems. Returns: Id, ActionId, CampaignId, ActionTrackerId, EventCode, State, StateDetail, StateDetailDescription, AdId, ReportingState, DeltaPayout, DeltaAmount, Currency, Category, Sku, Quantity, CatalogName, CatalogCategory, CatalogDescription, CatalogManufacturer, CatalogOriginalFormatCategory,…

get_single_impact_action_update_by_id

Get a single impact.com action update by id. Returns: Id, openapi, info, tags, servers, security, components, paths. Required: id.

list_all_impact_action_inquiries

List action inquiries for your impact.com campaigns, ordered by creation date (newest first). Returns each inquiry with Id, CampaignId, CampaignName, OrderId, TransactionDate, TransactionAmount, InquiryType, ResolutionStatus, RejectReason, FinalPayout, Comments, CreationDate, and Uri.

create_a_impact_action_inquiry

Create a new action inquiry in impact.com to dispute a tracked transaction. Returns: Status, Uri, openapi, info, servers, paths, components. Required: CampaignId, OrderId, TransactionDate, TransactionAmount, InquiryType.

get_single_impact_action_inquiry_by_id

Retrieve a single action inquiry from impact.com by its unique id. Returns the full inquiry object including Id, CampaignId, CampaignName, OrderId, TransactionDate, TransactionAmount, InquiryType, ResolutionStatus, RejectReason, FinalPayout, Comments, CreationDate, and Uri. Required: id.

list_all_impact_ads

List all ads available to your impact.com partner account, filterable by type, campaign, deal, mobile readiness, and update date range. Returns: Id, Name, Description, CampaignId, CampaignName, Type, TrackingLink, LandingPageUrl, AdvertiserId, AdvertiserName, Code, IFrameCode, Width, Height, CreativeUrl, Labels, AllowDeepLinking, MobileReady, Language, StartDate, EndDate, Season, TopSeller,…

get_single_impact_ad_by_id

Get a single impact.com ad by id. Returns the full ad object including Id, Name, Type, CampaignId, TrackingLink, LandingPageUrl, deal details, and creative dimensions. Required: id.

impact_ads_get_code

Retrieve the HTML code for a specific impact.com ad with optional tracking parameters appended to the embedded tracking link. Returns: Code, Uri, openapi, info, tags, servers, paths. Required: ad_id.

impact_ads_get_iframe_code

Retrieve the iframe code for a specific impact.com ad with optional tracking parameters appended to the embedded tracking link. Returns: IFrameCode, Uri, openapi, info, tags, servers, paths. Required: ad_id.

impact_ads_get_tracking_link

Retrieve the tracking link for a specific impact.com ad with optional sub-Ids and deep-link overrides appended. Returns: TrackingLink, Uri, openapi, info, tags, servers, paths. Required: ad_id.

list_all_impact_programs

List all joined impact.com programs (campaigns). Returns each program with CampaignId, AdvertiserName, CampaignName, Type, ContractStatus, TrackingLink, CampaignDescription, ShippingRegions, and deeplinking details.

get_single_impact_program_by_id

Get a single impact.com program by id. Returns the full program object including CampaignId, AdvertiserName, CampaignName, Type, ContractStatus, TrackingLink, CampaignDescription, ShippingRegions, and deeplinking details. Required: id.

impact_programs_get_logo

Retrieve a program's logo image in impact.com. Returns the logo as binary image data in GIF, PNG, or JPEG format depending on the Accept header. Required: campaign_id.

list_all_impact_catalogs

List all product catalogs available to your impact.com partner account, optionally filtered by campaign. Returns: Id, Name, Language, AdvertiserId, AdvertiserName, AdvertiserLocation, CampaignId, CampaignName, NumberOfItems, DateLastUpdated, Locations, Currency, ServiceAreas, FTPLocations, ItemsUri, Uri.

get_single_impact_catalog_by_id

Retrieve the details of an existing impact.com catalog by its unique Id. Returns: Id, Name, Language, AdvertiserId, AdvertiserName, AdvertiserLocation, CampaignId, CampaignName, NumberOfItems, DateLastUpdated, Locations, Currency, ServiceAreas, FTPLocations, ItemsUri, Uri, openapi, info, tags, servers, paths, components. Required: id.

list_all_impact_catalog_items

List all items in a specific impact.com catalog. Returns: Id, CatalogId, CampaignId, CampaignName, CatalogItemId, Name, Description, MultiPack, Bullets, Labels, Manufacturer, Url, MobileUrl, ImageUrl, ProductBid, AdditionalImageUrls, Promotions, CurrentPrice, OriginalPrice, DiscountPercentage, Currency, StockAvailability, EstimatedShipDate, LaunchDate, ExpirationDate, Gtin, GtinType, Asin, Mpn,…

get_single_impact_catalog_item_by_id

Get a single catalog item from impact.com by id. Returns: Id, CampaignId, CampaignName, Name, Description, Url, Currency, Uri, openapi, info, tags, servers, paths, components. Required: catalog_id, id.

impact_catalog_items_search

Search for items across all available impact.com catalogs using a keyword. Returns: Id, CatalogId, CampaignId, CampaignName, CatalogItemId, Name, Description, MultiPack, Bullets, Labels, Manufacturer, Url, MobileUrl, ImageUrl, ProductBid, AdditionalImageUrls, Promotions, CurrentPrice, OriginalPrice, DiscountPercentage, Currency, StockAvailability, EstimatedShipDate, LaunchDate, ExpirationDate,…

get_single_impact_click_by_id

Retrieve a click event in impact.com by its unique id. Returns the full click object including Id, CampaignId, EventDate, AdType, DeviceType, Payout, UniqueClick, and geo/attribution details. Required: id. The Clicks endpoint has been deprecated in favor of ClickExport.

impact_click_export_export

Schedule an asynchronous export of click event data in impact.com as CSV, JSON, or XML. Returns: Status, QueuedUri, ResultUri, ReplayUri, openapi, info, tags, servers, paths. Poll the QueuedUri via the Partner Jobs API to track progress and download the result from ResultUri when complete. The exported result uses ProgramId and ProgramName instead of CampaignId and CampaignName. Date defaults to…

list_all_impact_contracts

List all contracts associated with your impact.com partner account, with optional filtering by campaign, status, signatory, and date ranges. Returns each contract's Id, CampaignId, Status, StartDate, EndDate, Terms, HasCampaignTerms, PdfUri, and Uri. If the Status filter is omitted, only ACTIVE contracts are returned. Use Get a Contract to retrieve full CampaignTerms details.

get_single_impact_contract_by_id

Retrieve full details of an existing impact.com partner contract by id, including complete campaign-level term overrides. Returns: Id, Status, Uri, openapi, info, tags, servers, security, components, paths. Required: id. Append ?IRVersion=15 to retrieve CampaignTerms objects.

create_a_impact_conversion

Submit a conversion event to impact.com for tracking and attribution. Returns: Status, QueuedUri, warnings, openapi, info, tags, servers, paths, components. Required: ActionTrackerId, CampaignId, EventDate, OrderId, and either MediaPartnerId or MediaId. Do not send Amount together with item-level fields.

list_all_impact_deals

List all deals associated with a specific campaign in impact.com, with optional filters by scope, state, and type. Returns each deal's Id, Name, Description, State, Type, Scope, DiscountType, StartDate, EndDate, DateCreated, and DateLastUpdated. Required: campaign_id.

get_single_impact_deal_by_id

Get a single deal by id from a specific campaign in impact.com. Returns the full deal object including Id, Name, Description, State, Type, Scope, DiscountType, StartDate, EndDate, DateCreated, and DateLastUpdated. Required: campaign_id, id.

get_single_impact_exception_list_by_id

Get a single exception list in impact.com by id. The ExceptionListId can be obtained from the Contracts API. Returns: Id, Name, State, CampaignId, Type, CreatedDate, DeactivationDate, NumberOfItems, ItemsUri, Uri, openapi, info, tags, servers, paths, components. Required: id.

list_all_impact_exception_list_items

List all items in a specific impact.com exception list. Each item defines a product category or SKU value that triggers an alternate commission rate. Returns: Id, ListId, Name, Value, MatchMode, CreatedDate, Uri. Required: exception_list_id.

impact_identity_verification_create_session

Create or resume an identity verification session in impact.com. If a session is already in progress for the specified user, the existing session details are returned so verification can resume. Returns: Status, Uri, id, sessionId, sessionUrl, memberId, openapi, info, tags, servers, paths, components. Required: UserId.

list_all_impact_invoices

List impact.com partner invoices sorted by most recent first. Returns each invoice with Id, CreatedDate, RecipientName, Currency, TotalAmount, LineItems, and DetailedLineItems. Optional StartDate and EndDate query parameters filter by invoice creation date range.

get_single_impact_invoice_by_id

Get a single impact.com partner invoice by id. Returns the full invoice object including Id, CreatedDate, RecipientName, Currency, TotalAmount, LineItems, and DetailedLineItems. Required: id.

impact_invoices_download

Download a specific impact.com partner invoice as a PDF file. Returns the invoice in PDF binary format. Required: invoice_id.

list_all_impact_jobs

List impact.com partner jobs filtered by creation date. Returns: Id, Type, ProgramId, CreatedBy, CreatedDate, StartedDate, CompletedDate, AbandonedDate, CancelledDate, FailedDate, LastProgressUpdateDate, Status, StatusMessage, RecordsProcessed, PercentageComplete, Replayable, ResultUri.

get_single_impact_job_by_id

Retrieve the status of a single impact.com partner job by id. Returns: Id, Type, ProgramId, CreatedBy, CreatedDate, StartedDate, CompletedDate, AbandonedDate, CancelledDate, FailedDate, LastProgressUpdateDate, Status, StatusMessage, RecordsProcessed, PercentageComplete, Replayable, ResultUri, openapi, info, tags, servers, security, components, paths. Required: id.

impact_jobs_download

Download the result file of a completed impact.com partner job. If the job is not yet complete, returns the current job status instead. Job results are available for download for 90 days. Returns: Id, Type, ProgramId, CreatedBy, CreatedDate, StartedDate, CompletedDate, AbandonedDate, CancelledDate, FailedDate, LastProgressUpdateDate, Status, StatusMessage, RecordsProcessed, PercentageComplete,…

impact_jobs_replay

Replay a completed impact.com partner job, re-running it to produce updated or additional results. Intended for jobs with COMPLETED, FAILED, or CANCELLED status. Returns: Id, Type, ProgramId, CreatedBy, CreatedDate, StartedDate, CompletedDate, AbandonedDate, CancelledDate, FailedDate, LastProgressUpdateDate, Status, StatusMessage, RecordsProcessed, PercentageComplete, Replayable, ResultUri,…

list_all_impact_media_properties

List all media properties for your impact.com partner account. Returns: Id, Name, Thumbnail, Description, Tags, RevenueModel, Url, Type, MonthlyUniqueVisitors, AlexaRating, QuantcastRating, OwnershipVerified, MobilePlatform, AppStoreRating, Installs, Price, SocialPlatform, Followers, Handle, Uri.

create_a_impact_media_property

Create a new media property in impact.com. New media properties must be verified by impact.com before they are fully approved. Returns: Status, Uri, openapi, info, tags, servers, security, components, paths. Required: Name, Type, Url.

get_single_impact_media_property_by_id

Get a single media property by id in impact.com. Returns: Id, Name, Thumbnail, Description, Tags, RevenueModel, Url, Type, MonthlyUniqueVisitors, AlexaRating, QuantcastRating, OwnershipVerified, MobilePlatform, AppStoreRating, Installs, Price, SocialPlatform, Followers, Handle, Uri, openapi, info, tags, servers, security, components, paths. Required: id.

update_a_impact_media_property_by_id

Update an existing media property in impact.com. Only submitted fields are changed; omitted fields remain unchanged. Returns: Status, Uri, openapi, info, tags, servers, security, components, paths. Required: id.

delete_a_impact_media_property_by_id

Permanently delete a media property by id in impact.com. This action cannot be undone. Returns: Status, openapi, info, tags, servers, security, components, paths. Required: id.

list_all_impact_promo_codes

List promo codes available to your partner account in impact.com. Returns each promo code with Id, Code, State, Program, Advertiser, Deal, MatchMode, CreditRule, CreatedDate, StartDate, EndDate, and Uri. Supports filtering by program, advertiser, deal, credit rule, match mode, and creation/start/end date ranges.

get_single_impact_promo_code_by_id

Get a single promo code by id in impact.com. Returns the full promo code object including Id, Code, State, Program, Advertiser, Deal, MatchMode, CreditRule, CreatedDate, StartDate, EndDate, and Uri. Required: id.

get_single_impact_promo_code_exception_list_by_id

Get details of a specific promo code exception list in impact.com by id. Returns: Id, Name, State, CampaignId, CreatedDate, DeactivationDate, NumberOfItems, ItemsUri, Uri, openapi, info, tags, servers, paths, components. Required: id.

list_all_impact_promo_code_exception_list_items

List all items in a specific promo code exception list in impact.com. Each item defines a promo code value that triggers an alternate commission rate. Returns: Id, ListId, Name, Value, MatchMode, CreatedDate, Uri. Required: promo_code_exception_list_id.

list_all_impact_promotions

List brand promotions currently available to your impact.com partner account. Returns: AdvertiserId, AdvertiserName, AdvertiserLocation, PromotionFileId, PromotionIds, PromotionTitle, NumberOfProducts, PromotionEffectiveDates, GenericRedemptionCode, PromotionItemsUri, Uri.

get_single_impact_promotion_by_id

Get a single brand promotion by id in impact.com. Returns: AdvertiserId, AdvertiserName, AdvertiserLocation, PromotionFileId, PromotionIds, PromotionTitle, NumberOfProducts, PromotionEffectiveDates, GenericRedemptionCode, PromotionItemsUri, Uri, openapi, info, tags, servers, security, components, paths. Required: id (use the value of PromotionIds from a list response).

list_all_impact_reports

List all available impact.com reports. Returns: Name, Id, Category, Description, ApiAccessible, ApiRunUri, DeferredApiRunUri, MetaDataUri, RunUri. Only reports with ApiAccessible set to true can be run programmatically; the rest are UI-only.

impact_reports_run

Run an impact.com report synchronously and return rows inline. Returns: Records, openapi, info, tags, servers, security, components, paths. Required: report_id, START_DATE, END_DATE. Page size is fixed at 20,000 rows; for larger datasets use the Report Export endpoint.

impact_reports_get_metadata

Retrieve metadata for an impact.com report describing its accepted filters and returned columns. Returns: Name, Id, Description, Filters, Attributes, RunUri, Uri, openapi, info, tags, servers, security, components, paths. Required: report_id. Call this before running a report to learn its exact contract.

impact_report_export_export

Schedule an asynchronous report export in impact.com and poll for results via the Partner Jobs API. Returns: Status, QueuedUri, ResultUri, ReplayUri, openapi, info, tags, servers, security, components, paths. Required: report_export_id, START_DATE, END_DATE. Use instead of Run Report for datasets exceeding 20,000 rows.

list_all_impact_stores

List all impact.com partner storefronts available to your account. Returns each store's Id, Name, NumberOfGroups, DateLastUpdated, StoreUri, StoreAvatar, StoreBanner, Uri, and a nested Groups array with each group's Id, Name, Status, and CatalogId.

get_single_impact_store_by_id

Get a single impact.com store by id, including its curated groups. Returns: Id, Name, NumberOfGroups, DateLastUpdated, StoreUri, StoreAvatar, StoreBanner, Uri, Groups, openapi, info, tags, servers, security, components, paths. Required: id.

list_all_impact_store_items

List catalog items belonging to a specific impact.com store group, sorted by most recently created. Returns: Id, CatalogId, CampaignId, CampaignName, CatalogItemId, Name, Description, MultiPack, Bullets, Labels, Manufacturer, Url, MobileUrl, ImageUrl, ProductBid, AdditionalImageUrls, Promotions, CurrentPrice, OriginalPrice, DiscountPercentage, Currency, StockAvailability, EstimatedShipDate,…

impact_tax_documents_get_latest

Retrieve the most recently saved tax document for the partner account in impact.com. Returns: Id, UserId, Email, Status, EnvelopeId, Type, SubmitDate, UpdateDate, Provider, Uri, openapi, info, tags, servers, security, components, paths.

create_a_impact_tax_document

Create a new tax document submission in impact.com and receive an iframe URL for the partner to sign the form. Returns: Status, Uri, Email, Id, UserId, Url, openapi, info, tags, servers, security, components, paths. All body parameters except Provider apply to DocuSign only.

get_single_impact_tax_document_by_id

Retrieve a specific tax document by its unique Id in impact.com. Returns: Id, UserId, Email, Status, EnvelopeId, Type, SubmitDate, UpdateDate, Provider, Uri, openapi, info, tags, servers, security, components, paths. Required: id.

list_all_impact_tax_documents

List all tax documents submitted for the partner account in impact.com. Returns: Id, UserId, Email, Status, EnvelopeId, Type, SubmitDate, UpdateDate, Provider, Uri.

impact_tax_documents_complete

Record the outcome of a Comply Exchange tax document submission in impact.com so the document is recorded as submitted. Returns: Status, Uri, openapi, info, tags, servers, security, components, paths. Required: id, event. Only for Comply Exchange; DocuSign completes via the ReturnUrl callback supplied at Create time.

create_a_impact_tracking_link

Create a partner tracking link for a brand program in impact. Returns: TrackingURL, openapi, info, tags, servers, paths. Required: program_id. Up to 5,000 vanity links per account; exceeding that limit returns 403 Forbidden. Type=Vanity requires CustomPath.

list_all_impact_users

List all impact.com partner-account users sorted by join date with the earliest first. Returns each user's Id, FirstName, LastName, Username, State, Language, AccessRights, JoinedDate, DateLastUpdated, LastUpdatedBy, CreatedBy, and Uri. Supports optional Name and State filters.

get_single_impact_user_by_id

Get a single impact.com partner-account user by Id. Returns: Id, FirstName, LastName, Username, State, Language, AccessRights, JoinedDate, DateLastUpdated, LastUpdatedBy, CreatedBy, Uri, openapi, info, tags, servers, security, components, paths. Required: id.

list_all_impact_withdrawal_settings

Retrieve the partner's current withdrawal settings in impact.com, including bank account, PayPal, and payment scheduling configuration. Returns: BankCountry, openapi, info, tags, servers, security, components, paths. A 404 is returned when no withdrawal settings are configured for the account.

impact_withdrawal_settings_get_required_fields

Retrieve the mandatory banking fields for configuring withdrawal settings for a given country and optionally a specific payment method in impact.com. Call this before updating settings for a country you haven't configured before. Returns: BankCountry, Currency, PaymentMethods, openapi, info, tags, servers, security, components, paths. Required: bankCountry.

impact_withdrawal_settings_bulk_update

Update the partner's withdrawal settings in impact.com. Only provided fields are changed; omitted fields remain unchanged. Call the RequiredFields endpoint first to learn which fields are mandatory for your country and payment method. Returns: Status, Uri, openapi, info, tags, servers, security, components, paths.