API: Analysis

https://openmenu.com/api/v2/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 of the restaurant
format: generated key

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]

id

Generated key for the restaurant

key_phrases

return of key_phrases(s) with the following structure

phrase: 2 - 125 characters
frequency: integer
first_occurrence_postion: integer
score: float

syntax

return of syntax(s) with the following structure

lemma: 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

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

{
    "response": {
        "api": {
            "status": 200,
            "api_version": "2.2",
            "format": "json",
            "api_key": "[your_key]"
        },
        "result": {
            "key_phrases": {
                "phrase": "",
                "frequency": "",
                "first_occurrence_postion": "",
                "score": ""
            },
            "syntax": {
                "lemma": "",
                "part_of_speech": "",
                "frequency": "",
                "first_occurrence_postion": "",
                "score": ""
            }
        }
    }
}

Notes

use an ID of 'sample' (no quotes, no other options) for a sample result that doesn't count against your credits.

Parameters

Return Values

Return Status Codes

Sample Response

Notes