« Back to Documentation Overviewget_goals
Section: Goals
Version: 1.5.0
Get goals.
Conditions:
- profile (optional) – Use text operators to narrow down search results to specific profile name.
- domain (optional) – Use text operators to narrow down search results to specific goal domain.
- name (optional) – Use text operators to narrow down search results to specific goal name.
- url (optional) – Use text operators to narrow down search results to specific goal URL.
Parameters
|
---|
string | API_KEY |
object | object | profile | | object | domain | | object | name | | object | url | |
|
Return Value
|
---|
object | GOAL_ID | string | profile | Goals on my page | string | domain | myhomepage.com | string | name | My shop | string | url | http://myhomepage.com/shop |
|
Example Request JSON
[
"API_KEY",
{
"profile": {
"OPERATOR": "value"
},
"domain": {
"OPERATOR": "value"
},
"name": {
"OPERATOR": "value"
},
"url": {
"OPERATOR": "value"
}
}
]
Example Response JSON
{
"GOAL_ID": {
"profile": "Goals on my page",
"domain": "myhomepage.com",
"name": "My shop",
"url": "http:\/\/myhomepage.com\/shop"
}
}
API-wide Errors
|
---|
API key verification failed
| API key verification failed |
API client IP not allowed
| API client IP not allowed |
Invalid params
| Attribute params must be reference to hash |