« Back to Documentation Overview

get_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
stringAPI_KEY
object
objectprofile
stringOPERATORvalue
objectdomain
stringOPERATORvalue
objectname
stringOPERATORvalue
objecturl
stringOPERATORvalue
Return Value
objectGOAL_ID
stringprofileGoals on my page
stringdomainmyhomepage.com
stringnameMy shop
stringurlhttp://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