Moderated Actions

Record commercial click

Record website, call, profile, claim, Trust Card, or badge click analytics.

post/v1/actions/commercial-click

Request

  • Base URL: https://loppee.com
  • URL: https://loppee.com/v1/actions/commercial-click
  • Auth: none required

Request body

action_type'website' | 'call' | 'view_profile' | 'claim' | 'trust_card' | 'badge' | 'directions' | 'recommend' required
source_type'published_profile' | 'directory_listing' required
business_idstring
listing_idstring
directory_listing_idstring

Deprecated alias of listing_id.

display_namestring
categorystring
citystring
statestring
commercial_status'free' | 'paid' | 'sponsored'
target_urlstring
page_pathstring
referrerstring
metadataobject
ad_receiptstring

Opaque server-signed receipt of a served Sponsored ad, sent back unchanged with a profile, website or call tap. Only a receipt that validates on Loppee's server makes the tap an ad tap; without one the click is ordinary.

surface'assistant' | 'web'

Where the Sponsored ad was shown (with ad_receipt).

Response

CommercialClickResponse

status'recorded' | 'recorded_fallback' required
storage'commercial_click_events' | 'service_interactions' required
click_idstring required
billing_event_idstring nullable
fallback_interaction_idstring
billableboolean required
billing_statusstring required
ledger_statusstring required
migration_requiredboolean
created_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.