POST /user_permission.json

Description: Grants a user permission to view or administrate a specific project.

API Endpoint URL: https://api.improvely.com/v1/user_permission.json

Note: Either id or email must be provided to identify which user to grant this permission to.

Example request:

curl https://api.improvely.com/v1/user_permission.json \
  -X POST \
  -d 'key=90c0d64fds653338as6869e54267e05&email=dan@awio.com&project=1&permission=full'

Example successful response (HTTP status code 200):

{
    "status": "success"
}

Example failure response (HTTP status code: 400):

{
    "status": "error",
    "type": "parameters",
    "message": "Missing parameter: either `id` or `email` must be provided."
}

More from this category

• Introduction
• Authentication
• Supported Time Zones
• POST /project.json
• PUT /project.json
• DELETE /project.json
• POST /link.json
• POST /conversion.json
• POST /user.json
• DELETE /user.json
• PUT /user_permission.json
• DELETE /user_permission.json

Authentication

The HTTP API is available to all Improvely accounts. You identify yourself to the API by including an API key parameter in your request. You can retrieve your API key by clicking on the gear icon at the top menu in your account, then clicking on API Credentials.

The API Credentials page is visible only to account administrators, and API keys have the same rights to an account as an administrator-level user; they may add, delete or alter data in all projects.

More from this category

• Introduction
• Supported Time Zones
• POST /project.json
• PUT /project.json
• DELETE /project.json
• POST /link.json
• POST /conversion.json
• POST /user.json
• DELETE /user.json
• POST /user_permission.json
• PUT /user_permission.json
• DELETE /user_permission.json

Supported Time Zones

The following time zones are valid values for the timezone parameter in any API endpoint that allows one.

More from this category

• Introduction
• Authentication
• POST /project.json
• PUT /project.json
• DELETE /project.json
• POST /link.json
• POST /conversion.json
• POST /user.json
• DELETE /user.json
• POST /user_permission.json
• PUT /user_permission.json
• DELETE /user_permission.json

POST /project.json

Description: Creates a new project in your Improvely account, and returns the project’s ID and code snippet for integration. A project typically represents one website you are using Improvely to track visits and conversions on.

API Endpoint URL: https://api.improvely.com/v1/project.json

Example request:

curl https://api.improvely.com/v1/project.json \
  -X POST \
  -d 'key=90c0d64fds653338as6869e54267e05&name=My+Store&currency=$&google_url_compatibility=true&track_organic=true&max_clicks=5&fraud_message=You%20have%20been%20detected%20clicking%20this%20ad%20more%20than%205%20times%20in%20the%20past%2024%20hours.%20This%20information%2C%20including%20your%20IP%20address%20and%20geographic%20location%2C%20has%20been%20logged%20and%20sent%20to%20the%20owner%20of%20this%20ad.&goal_mode=all&attribution_model=firstad&duplicate_filter=false'

Example successful response (HTTP status code 200):

{
    "status": "success",
    "id": 3,
    "website_code": "<script type=\"text/javascript\">\r\nvar im_domain = 'example';\r\nvar im_project_id = 3;\r\n(function(e,t){window._improvely=[];var n=e.getElementsByTagName(\"script\")[0];var r=e.createElement(\"script\");r.type=\"text/javascript\";r.src=\"https://\"+im_domain+\".iljmp.com/improvely.js\";r.async=true;n.parentNode.insertBefore(r,n);if(typeof t.init==\"undefined\"){t.init=function(e,t){window._improvely.push([\"init\",e,t])};t.goal=function(e){window._improvely.push([\"goal\",e])};t.label=function(e){window._improvely.push([\"label\",e])}}window.improvely=t;t.init(im_domain,im_project_id)})(document,window.improvely||[])\r\n</script>"
}

Example failure response (HTTP status code: 400):

{
    "status": "error",
    "type": "parameters",
    "message": "Invalid parameter value: `track_organic`."
}

More from this category

• Introduction
• Authentication
• Supported Time Zones
• PUT /project.json
• DELETE /project.json
• POST /link.json
• POST /conversion.json
• POST /user.json
• DELETE /user.json
• POST /user_permission.json
• PUT /user_permission.json
• DELETE /user_permission.json

PUT /project.json

Description: Updates the settings for a project. Any parameters you do not provide values for will retain their current value.

API Endpoint URL: https://api.improvely.com/v1/project.json

Example request:

curl https://api.improvely.com/v1/project.json \
  -X PUT \
  -d 'key=90c0d64fds653338as6869e54267e05&id=3&duplicate_filter=true'

Example successful response (HTTP status code 200):

{
    "status": "success"
}

Example failure response (HTTP status code: 400):

{
    "status": "error",
    "type": "parameters",
    "message": "Missing or invalid required parameter: `id`."
}

More from this category

• Introduction
• Authentication
• Supported Time Zones
• POST /project.json
• DELETE /project.json
• POST /link.json
• POST /conversion.json
• POST /user.json
• DELETE /user.json
• POST /user_permission.json
• PUT /user_permission.json
• DELETE /user_permission.json

DELETE /project.json

Description: Deletes a project.

API Endpoint URL: https://api.improvely.com/v1/project.json

Example request:

curl https://api.improvely.com/v1/project.json \
  -X DELETE\
  -d 'key=90c0d64fds653338as6869e54267e05&id=3'

Example successful response (HTTP status code 200):

{
    "status": "success"
}

Example failure response (HTTP status code: 400):

{
    "status": "error",
    "type": "parameters",
    "message": "Missing or invalid required parameter: `id`."
}

More from this category

• Introduction
• Authentication
• Supported Time Zones
• POST /project.json
• PUT /project.json
• POST /link.json
• POST /conversion.json
• POST /user.json
• DELETE /user.json
• POST /user_permission.json
• PUT /user_permission.json
• DELETE /user_permission.json

POST /link.json

Description: Creates a new Tracking Link. Tracking links keep track of clicks from ads or other marketing efforts, track their costs, and monitor clicks for signs of click fraud.

API Endpoint URL: https://api.improvely.com/v1/link.json

Example request:

curl https://api.improvely.com/v1/link.json \
  -X POST \
  -d 'key=90c0d64fds653338as6869e54267e05&project=1&url=http%3A%2F%2Fwww.example.com&campaign=Google+AdWords&medium=PPC&source=Product+Listing+Ads&content=Natural+Skincare&cost_type=PPC&cost=0.50&custom_url=skincare1'

Example successful response (HTTP status code 200):

{
    "status": "success",
    "google": {
        "short_link": "https://awio.iljmp.com/1/skincare1?kw={keyword}",
        "direct_link": "http://www.example.com/?ims=skincare1&kw={keyword}"
    },
    "bing": {
        "short_link": "https://awio.iljmp.com/1/skincare1?kw={keyword}",
        "direct_link": "http://www.example.com/?ims=skincare1&kw={keyword}"
    },
    "7search": {
        "short_link": "https://awio.iljmp.com/1/skincare1?kw=###KEYWORD###",
        "direct_link": "http://www.example.com/?ims=skincare1&kw=###KEYWORD###"
    },
    "anywhere": {
        "short_link": "https://awio.iljmp.com/1/skincare1",
        "direct_link": "http://www.example.com/?ims=skincare1"
    }
}

Example failure response (HTTP status code: 400):

{
    "status": "error",
    "type": "parameters",
    "message": "Missing required parameter: `campaign`."
}

More from this category

• Introduction
• Authentication
• Supported Time Zones
• POST /project.json
• PUT /project.json
• DELETE /project.json
• POST /conversion.json
• POST /user.json
• DELETE /user.json
• POST /user_permission.json
• PUT /user_permission.json
• DELETE /user_permission.json

POST /conversion.json

Description: Creates a new Goal Conversion attached to a previous visitor to your website. This method is commonly used to record recurring bills or offline sales.

API Endpoint URL: https://api.improvely.com/v1/conversion.json

Important Notes: Either a visitor label, IP and user-agent pair, previous reference or subid value must be specified in order to identify which visitor profile to attach this conversion to. If no profile can be found, the conversion will not be created. This API cannot be used to record arbitrary events that are not linked to a previous website visitor. The project attribute is required unless a subid is specified.

Example request:

curl https://api.improvely.com/v1/conversion.json \
  -X POST \
  -d 'key=90c0d64fds653338as6869e54267e05&project=1&previous_reference=54321&goal=Subscription+Renewal&revenue=29&reference=54321+Renewal+9/26&date=1411694111&notify=false'

Example successful response (HTTP status code 200):

{
    "status": "success"
}

Example failure response (HTTP status code: 400):

{
    "status": "error",
    "type": "parameters",
    "message": "Missing required parameter: `label`, `ip` and `user_agent`, `previous_reference` or `subid`."
}

More from this category

• Introduction
• Authentication
• Supported Time Zones
• POST /project.json
• PUT /project.json
• DELETE /project.json
• POST /link.json
• POST /user.json
• DELETE /user.json
• POST /user_permission.json
• PUT /user_permission.json
• DELETE /user_permission.json

POST /user.json

Description: Creates a new user for logging in to your Improvely account. This method is only available to accounts on the Startup or Agency billing plans.

API Endpoint URL: https://api.improvely.com/v1/user.json

Example request:

curl https://api.improvely.com/v1/user.json \
  -X POST \
  -d 'key=90c0d64fds653338as6869e54267e05&first_name=Dan&last_name=Grossman&email=dan@awio.com&password=itsasecret'

Example successful response (HTTP status code 200):

{
    "status": "success",
    id: 3
}

Example failure response (HTTP status code: 400):

{
    "status": "error",
    "type": "parameters",
    "message": "Missing required parameter: `email`."
}

More from this category

• Introduction
• Authentication
• Supported Time Zones
• POST /project.json
• PUT /project.json
• DELETE /project.json
• POST /link.json
• POST /conversion.json
• DELETE /user.json
• POST /user_permission.json
• PUT /user_permission.json
• DELETE /user_permission.json

DELETE /user.json

Description: Deletes a user account.

API Endpoint URL: https://api.improvely.com/v1/user.json

Note: Either id or email must be provided to identify which user to delete.

Example request:

curl https://api.improvely.com/v1/user.json \
  -X DELETE \
  -d 'key=90c0d64fds653338as6869e54267e05&email=dan@awio.com'

Example successful response (HTTP status code 200):

{
    "status": "success"
}

Example failure response (HTTP status code: 400):

{
    "status": "error",
    "type": "parameters",
    "message": "Missing parameter: either `id` or `email` must be provided."
}

More from this category

• Introduction
• Authentication
• Supported Time Zones
• POST /project.json
• PUT /project.json
• DELETE /project.json
• POST /link.json
• POST /conversion.json
• POST /user.json
• POST /user_permission.json
• PUT /user_permission.json
• DELETE /user_permission.json