https://openmenu.com/api/v2/gap_analysis.php?key=[API_KEY] + parameters

Parameters

key
[required] key for access to the API (get/view your key)
format: api key
id
[required] id which was provided by the results of a call
format: generated key
postal_code
[not required] Limit the results to a location.
format: postal code to limit search results
city
[not required] Limit the results to a location.
format: string
state
[not required] Force the results to be limited to a single state.
format: 2 characters (two-digit code)
country
[required] Limit the results to a single country.
format: ISO 3166-1 alpha-2

Return Values

api
Returns details about the API and call
  • status: see below Return Status Codes
  • api_version: 2.2
  • format: json
  • api_key: [your api key]
openmenu
return of terms with the following structure
  • term: 2 - 75 characters
  • frequency: integer
  • first_occurrence_postion: integer
  • score: float
  • part_of_speech: ADJ | ADP | ADV | AUX | CCONJ | DET | INTJ | NOUN | NUM | O | PART | PRON | PROPN | PUNCT | SCONJ | SYM | VERB
  • type: syntax | key_phrases
return of menu_item with the following structure
  • mi_name: 2 - 75 characters
  • mi_description: 0 - 450 characters
  • mi_group_name: 2 - 75 characters
  • avg_price: numeric
  • first_occurrence_postion: integer
  • frequency: integer
  • has_fish: float (confidence score)
  • has_shellfish: float (confidence score)
  • has_beef: float (confidence score)
  • has_poultry: float (confidence score)
  • has_pork: float (confidence score)
  • has_lamb: float (confidence score)
  • is_appetizer: float (confidence score)
  • is_salad: float (confidence score)
  • is_side: float (confidence score)
  • is_burger: float (confidence score)
trends
return of frequency with the following structure
  • term: 2 - 125 characters
  • total_frequency: integer
  • avg_postion: float
  • score: float
  • weight: float
return of menu_item(s) with the following structure
  • mi_name: 2 - 75 characters
  • mi_description: 0 - 450 characters
  • total_frequency: integer
  • avg_postion: float
  • avg_price: float
  • score: float
  • weight: float
intersect
return of the term and menu_item structure where the OpenMenu and trends align (intersect)
diff
openmenu - return of the term and menu_item structure where the OpenMenu differs from the trends
diff
trends - return of the term and menu_item structure where the trends differ from the OpenMenu

Return Status Codes

200
successful call
204
call resulted in an empty resultset
400
incorrect or missing API key
404
incorrect or missing required parameter
429
call limit exceeded on API key (check your limit)

Sample Response