📘

This is a Yelp Partner API

Access is disabled by default. See Yelp Partner APIs on how to get access.

Overview

Partner Support API endpoints will allow partners to retrieve the latest business information, migration information and advertising program information about their businesses.

Authentication

Authentication uses basic HTTP authentication over SSL. The Data Ingestion API credentials are used to make calls to these APIs. To gain access to these APIs, please email [email protected]

Business Info API

Given a Yelp encrypted business id, this API returns business information, including business migration information and additional fields such as partner_business_id and cta values.

GET https://partner-api.yelp.com/v1/business_info/<business_ids>

Request parameters

• business_ids
• Comma-delimited list of yelp business ids. Supports up to 200 ids.

Response parameters

• name
• address1
• address2
• address3
• city
• country
• state
• postal_code
• latitude
• longitude
• phone
• url
• display_url
• is_migrated (if true, the destination_yelp_business_id contains migrated id)
• destination_yelp_business_id
• is_closed
• is_removed_from_search
• additional_biz_info object
  • partner_business_id
  • metered_phone
  • cta object
  • category_list

Business Migration Info API

Given a Yelp encrypted business id, this API provides information about the migration path of a business.

GET https://partner-api.yelp.com/v1/business_migration_info/<business_ids>

Request parameters

• business_ids
• Comma-delimited list of yelp business ids. Supports up to 200 ids.

Response Parameters

• migration_type (MIGRATED, NONE)
• destination_business_id (id that the requested yelp_business_id has been migrated to)
• merged_business_ids (list of ids that have been merged into this biz)

Program Info API

Given a Yelp program id, this API returns the details of the advertising program.

GET https://partner-api.yelp.com/v1/programs/info/<program_ids>

Request parameters

• Comma-delimited list of program_ids (up to 200 program_ids)
• start (what index should the list start at, used as an offset to paginate through the complete list of programs)

Response parameters

• partner_business_id
• program_type (BP, CPC)
• start_date
• end_date
• program_status (ACTIVE, INACTIVE)
• program_pause_status (PAUSED, NOT_PAUSED)
• program_metrics
  • budget
  • currency
  • is_autobid
  • max_bid
  • billed_impressions
  • billed_clicks
  • ad_cost
  • fee_period (Calendar Month, Rolling Month)
• future_budget_changes
  • new_budget
  • start_date
  • old_budget
• page_upgrade_info
  • monthly_rate
  • cost
• active_features (LINK_TRACKING, NEGATIVE_KEYWORD_TARGETING, STRICT_CATEGORY_TARGETING, AD_SCHEDULING, CUSTOM_LOCATION_TARGETING, AD_GOAL, CALL_TRACKING, SERVICE_OFFERINGS_TARGETING)
• available_features (LINK_TRACKING, NEGATIVE_KEYWORD_TARGETING, STRICT_CATEGORY_TARGETING, AD_SCHEDULING, CUSTOM_LOCATION_TARGETING, AD_GOAL,
  CALL_TRACKING, SERVICE_OFFERINGS_TARGETING)

Program List API

Given a Yelp encrypted business id, this API returns the list of past, current and future advertising programs with info for each program (status, start/end date).

https://partner-api.yelp.com/v1/programs/list/<business_ids>start=0&limit=20

Request parameters

• business_ids - Comma-delimited list of yelp business ids. Supports up to 200 ids.
• Pagination for programs within each business:
  • start - Integer (Default: 0, Minimum: 0)
  • limit - Integer (Default: 20, Minimum: 0, Maximum: 40)

Response parameters

• yelp_business_id
• destination_yelp_business_id
  • Contains the yelp business id that this business was merged into.
  • null if business wasn't merged. (most common case)
• advertiser_status
• partner_business_id
• array of advertising programs_id
  • program_type (BP, CPC)
  • program_id
  • start_date
  • end_date
  • program_status (ACTIVE, INACTIVE)
  • program_pause_status (PAUSED, NOT_PAUSED)
• program_metrics
  • budget
  • currency
  • is_autobid
  • max_bid
  • billed_impressions
  • billed_clicks
  • ad_cost
  • fee_period (Calendar Month, Rolling Month)
• future_budget_changes
  • new_budget
  • start_date
  • old_budget
• page_upgrade_info
  • monthly_rate
  • cost
• available_features (LINK_TRACKING, NEGATIVE_KEYWORD_TARGETING, STRICT_CATEGORY_TARGETING, AD_SCHEDULING, CUSTOM_LOCATION_TARGETING, AD_GOAL, CALL_TRACKING, SERVICE_OFFERINGS_TARGETING)
• active_features (LINK_TRACKING, NEGATIVE_KEYWORD_TARGETING, STRICT_CATEGORY_TARGETING, AD_SCHEDULING, CUSTOM_LOCATION_TARGETING, AD_GOAL, CALL_TRACKING, SERVICE_OFFERINGS_TARGETING)

Program List All API

Returns the entire the list of past, current and future advertising programs under a given payment account with info for each program (status, start/end date).

GET https://partner-api.yelp.com/programs/v1

Request query parameters

• offset (optional - default: 0)
• limit (optional - default: 20 [min: 1, max: 40])
• program_status [PAST, PAUSED, CURRENT, FUTURE, ALL] (optional - default: current)

Response parameters

• program_status
• total (number of payment programs that match selected program status)
• limit
• offset
• array of payment_programs
  • program_type (BP, CPC, EP)
  • program_id
  • start_date
  • end_date
  • program_status (ACTIVE, INACTIVE)
  • program_pause_status (PAUSED, NOT_PAUSED)
  • program_metrics
    • budget
    • currency
    • is_autobid
    • max_bid
    • billed_impressions
    • billed_clicks
    • ad_cost
    • fee_period (Calendar Month, Rolling Month)
  • array of businesses
    • yelp_business_id
    • partner_business_id
  • future_budget_changes
    • new_budget
    • start_date
    • old_budget
  • page_upgrade_info
    • monthly_rate
    • cost
  • active_features (LINK_TRACKING, NEGATIVE_KEYWORD_TARGETING, STRICT_CATEGORY_TARGETING, AD_SCHEDULING, CUSTOM_LOCATION_TARGETING, AD_GOAL, CALL_TRACKING, SERVICE_OFFERINGS_TARGETING)
  • available_features (LINK_TRACKING, NEGATIVE_KEYWORD_TARGETING, STRICT_CATEGORY_TARGETING, AD_SCHEDULING, CUSTOM_LOCATION_TARGETING, AD_GOAL, CALL_TRACKING, SERVICE_OFFERINGS_TARGETING)

📘

Check out our Partner Support API Reference Page

Endpoints