Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

The specified customer account was able to be retrieved.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/accounts_get_response.json",
  "title": "Accounts",
  "type": "object",
  "item": {
    "title": "Accounts GET response",
    "type": "object",
    "required": [
      "status"
    ],
    "properties": {
      "status": {
        "description": "Accounts request status. SUCCESS if succeeded, FAILURE otherwise",
        "type": "string"
      },
      "items": {
        "description": "List of accounts",
        "type": "array",
        "item": {
          "description": "Account object that is created.",
          "type": "object",
          "properties": {
            "accountId": {
              "description": "Account UID.",
              "type": "string",
              "maxLength": 20
            },
            "name": {
              "description": "Full name of the account.",
              "type": "string",
              "maxLength": 200
            },
            "description": {
              "description": "Description of the account",
              "type": "string",
              "maxLength": 200
            },
            "timezone": {
              "description": "Time zone of the customer",
              "type": "string",
              "maxLength": 200
            },
            "identificationMethod": {
              "description": "The method used to identify the customer account: Account ID or CCI UUID",
              "type": "string"
            },
            "cciSubscriptionUUID": {
              "description": "The value for the subscription if CCI UUID is used to identify the customer account",
              "type": "string"
            },
            "cciEnvironment": {
              "description": "The value for the environment if CCI UUID is used to identify the customer account",
              "type": "string"
            },
            "licenseId": {
              "description": "License the customer is using",
              "type": "int"
            },
            "restApiGetSegmentsSecured": {
              "description": "If enabled, HMAC authentication is required to use the segments endpoint",
              "type": "boolean"
            },
            "restApiPostEventImportSecured": {
              "description": "If enabled, HMAC authentication is required to use the event import endpoint",
              "type": "boolean"
            },
            "restApiGetFileExportSecured": {
              "description": "If enabled, HMAC authentication is required to use the file export endpoint",
              "type": "boolean"
            },
            "restApiGetVisitorQuerySecured": {
              "description": "If enabled, HMAC authentication is required to use the visitor query endpoint",
              "type": "boolean"
            },
            "awsAccessKeyId": {
              "description": "The user's access key for accessing S3.",
              "type": "string"
            },
            "awsSecretAccessKey": {
              "description": "The user's secret access key for accessing S3.",
              "type": "string"
            },
            "ipAddressMasked": {
              "description": "If the IP address of the user should be masked",
              "type": "boolean"
            },
            "beta": {
              "description": "If the new Lift 4 UX (and functionality) is enabled",
              "type": "boolean"
            },
            "nextGenPerz": {
              "description": "If the nextGenPerz functionality is enabled",
              "type": "boolean"
            },
            "links": {
              "description": "Reference link for current resource",
              "type": "object",
              "properties": {
                "rel": {
                  "description": "The object that the link is related to.",
                  "type": "string"
                },
                "href": {
                  "description": "Reference link for current object.",
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Example:

{
  "status": "SUCCESS",
  "accounts": [
    {
      "name": "My account name",
      "description": "This is an example account",
      "timezone": "ACT",
      "accountId": "ACCOUNT_EXAMPLE",
      "licenseId": 7,
      "restApiGetSegmentsSecured": true,
      "restApiPostEventImportSecured": true,
      "restApiGetFileExportSecured": true,
      "restApiGetVisitorQuerySecured": true,
      "awsAccessKeyId": "ABCDEFGHIJKLMNOPQRST",
      "awsSecretAccessKey": "+1A/aBcD23/4EFG4HIjKlmNOPQ5Rs/TuvWXY67zA",
      "ipAddressMasked": false,
      "identificationMethod": "Account ID",
      "cciSubscriptionUUID": null,
      "cciEnvironment": null,
      "nextGenPerz": true,
      "beta": true,
      "links": [
        {
          "rel": "self",
          "href": "https://us-east-1-api.lift.acquia.com/api/v1/accounts/ACCOUNT_EXAMPLE"
        }
      ]
    }
  ]
}

HTTP status code 403

Account resource is forbidden or inaccessible to current user context.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/accounts_4xx.json",
  "title": "Accounts",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Accounts endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for accounts POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the accounts endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "MISSING_SECURITY_RESOURCE_PERMISSION",
      "message": "Missing security resource permission"
    }
  ]
}

HTTP status code 404

Account not found.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/accounts_4xx.json",
  "title": "Accounts",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Accounts endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for accounts POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the accounts endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "ACCOUNT_NOT_FOUND",
      "message": "Account not found"
    }
  ]
}

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

The specified customer account was updated successfully.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/accounts_post_put_response.json",
  "title": "Accounts",
  "type": "object",
  "item": {
    "title": "Accounts POST/PUT response",
    "type": "object",
    "required": [
      "status"
    ],
    "properties": {
      "status": {
        "description": "Accounts request status. SUCCESS if succeeded, FAILURE otherwise",
        "type": "string"
      },
      "errors": {
        "description": "List of errors upon status FAILURE",
        "type": "array",
        "items": {
          "description": "Error object containing information about failure",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 0
      },
      "items": {
        "description": "List of accounts",
        "type": "array",
        "required": [
          "id",
          "name",
          "timezone",
          "accountId"
        ],
        "item": {
          "description": "Account object that is created.",
          "type": "object",
          "properties": {
            "accountId": {
              "description": "Account UID.",
              "type": "string",
              "maxLength": 20
            },
            "name": {
              "description": "Full name of the account.",
              "type": "string",
              "maxLength": 200
            },
            "description": {
              "description": "Description of the account",
              "type": "string",
              "maxLength": 200
            },
            "timezone": {
              "description": "Timezone of the customer",
              "type": "string",
              "maxLength": 200
            },
            "identificationMethod": {
              "description": "The method used to identify the customer account: Account ID or CCI UUID",
              "type": "string"
            },
            "cciSubscriptionUUID": {
              "description": "The value for the subscription if CCI UUID is used to identify the customer account",
              "type": "string"
            },
            "cciEnvironment": {
              "description": "The value for the environment if CCI UUID is used to identify the customer account",
              "type": "string"
            },
            "licenseId": {
              "description": "License the customer is using",
              "type": "int"
            },
            "restApiGetSegmentsSecured": {
              "description": "If enabled, HMAC authentication is required to use the segments endpoint",
              "type": "boolean"
            },
            "restApiPostEventImportSecured": {
              "description": "If enabled, HMAC authentication is required to use the event import endpoint",
              "type": "boolean"
            },
            "restApiGetFileExportSecured": {
              "description": "If enabled, HMAC authentication is required to use the file export endpoint",
              "type": "boolean"
            },
            "restApiGetVisitorQuerySecured": {
              "description": "If enabled, HMAC authentication is required to use the visitor query endpoint",
              "type": "boolean"
            },
            "awsAccessKeyId": {
              "description": "The user's access key for accessing S3.",
              "type": "string"
            },
            "awsSecretAccessKey": {
              "description": "The user's secret access key for accessing S3.",
              "type": "string"
            },
            "ipAddressMasked": {
              "description": "If the IP address of the user should be masked",
              "type": "boolean"
            },
            "beta": {
              "description": "If the new Lift 4 UX (and functionality) is enabled",
              "type": "boolean"
            },
            "nextGenPerz": {
              "description": "If the nextGenPerz functionality is enabled",
              "type": "boolean"
            },
            "links": {
              "description": "Reference link for current resource",
              "type": "object",
              "properties": {
                "rel": {
                  "description": "The object that the link is related to.",
                  "type": "string"
                },
                "href": {
                  "description": "Reference link for current object.",
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Example:

{
  "status": "SUCCESS",
  "accounts": [
    {
      "name": "My account name",
      "description": "This is an example account",
      "timezone": "ACT",
      "accountId": "ACCOUNT_EXAMPLE",
      "licenseId": 7,
      "restApiGetSegmentsSecured": true,
      "restApiPostEventImportSecured": true,
      "restApiGetFileExportSecured": true,
      "restApiGetVisitorQuerySecured": true,
      "awsAccessKeyId": "ABCDEFGHIJKLMNOPQRST",
      "awsSecretAccessKey": "+1A/aBcD23/4EFG4HIjKlmNOPQ5Rs/TuvWXY67zA",
      "ipAddressMasked": false,
      "identificationMethod": "Account ID",
      "cciSubscriptionUUID": null,
      "cciEnvironment": null,
      "nextGenPerz": true,
      "beta": true,
      "links": [
        {
          "rel": "self",
          "href": "https://us-east-1-api.lift.acquia.com/api/v1/accounts/ACCOUNT_EXAMPLE"
        }
      ]
    }
  ]
}

HTTP status code 400

Invalid parameters, including licenseId, cciSubscriptionUUID, cciEnvironment, and/or identificationMethod.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/accounts_4xx.json",
  "title": "Accounts",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Accounts endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for accounts POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the accounts endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

{
  "status": "FAILURE",
  "errors": [
    {
      "statusCode": "MISSING_NAME",
      "message": "Missing name for the request"
    },
    {
      "statusCode": "MISSING_TIMEZONE",
      "message": "Missing timezone for the request"
    },
    {
      "statusCode": "MISSING_DESCRIPTION",
      "message": "Missing description for the request"
    },
    {
      "statusCode": "UNSUPPORTED_ARGUMENT",
      "message": "Unsupported Argument - Identification Method"
    },
    {
      "statusCode": "UNSUPPORTED_ARGUMENT",
      "message": "Unsupported Argument - CCI Subscription UUID"
    },
    {
      "statusCode": "UNSUPPORTED_ARGUMENT",
      "message": "Unsupported Argument - CCI Environment"
    },
    {
      "statusCode": "UNSUPPORTED_ARGUMENT",
      "message": "Unsupported Argument - License ID"
    },
    {
      "statusCode": "INVALID_DESCRIPTION_LENGTH",
      "message": "Invalid description - String length exceeds limit"
    }
  ]
}

HTTP status code 403

Account does not match user context.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/accounts_4xx.json",
  "title": "Accounts",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Accounts endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for accounts POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the accounts endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "MISSING_SECURITY_RESOURCE_PERMISSION",
      "message": "Missing security resource permission"
    }
  ]
}

HTTP status code 404

Account not found.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/accounts_4xx.json",
  "title": "Accounts",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Accounts endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for accounts POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the accounts endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "ACCOUNT_NOT_FOUND",
      "message": "Account not found"
    }
  ]
}

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 201

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/capture_response.json",
  "title": "Segments",
  "description": "Segments calculated by imported captures.",
  "type": "object",
  "required": [
    "touch_identifier",
    "identity",
    "identity_source"
  ],
  "properties": {
    "errors": {
      "description": "List of errors for the capture post.",
      "type": "array",
      "items": {
        "description": "Error object containing information on errors in captures.",
        "type": "object",
        "properties": {
          "code": {
            "description": "Error code.",
            "type": "string",
            "maxLength": 100
          },
          "message": {
            "description": "Human readable error message.",
            "type": "string",
            "maxLength": 200
          }
        }
      },
      "minItems": 0
    },
    "touch_identifier": {
      "type": "string",
      "maxLength": 22,
      "description": "Internal identifier for the touch. If touch_identifier is not passed in the request, value of this field will be generated."
    },
    "identity": {
      "type": "string",
      "maxLength": 200,
      "description": "Visitor's primary identity information."
    },
    "identity_source": {
      "type": "string",
      "maxLength": 200,
      "description": "Type of visitor's primary identity information. Specific string (account, email, facebook, twitter, tracking, name, amp) or custom identifier type. This will be 'tracking' if no identifier is passed in the request."
    },
    "matched_segments": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "name",
          "description"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "Matched segment tracking id."
          },
          "name": {
            "type": "string",
            "maxLength": 200,
            "description": "Matched segment name."
          },
          "description": {
            "type": "string",
            "maxLength": 4000,
            "description": "Matched segment description."
          }
        }
      }
    },
    "content_interactions": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "content_uuid",
          "type",
          "date_time"
        ],
        "properties": {
          "content_uuid": {
            "type": "string",
            "description": "Matched content uuid."
          },
          "type": {
            "type": "String",
            "enum": [
              "CONTENT_VIEW"
            ],
            "description": "The type of interaction with the content_uuid."
          },
          "date_time": {
            "type": "string",
            "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9].[0-9]{1,3}Z$",
            "description": "The date (in UTC) that the interaction with the content_uuid occurred (e.g., 2015-11-05T21:01:42.239Z)"
          }
        }
      }
    }
  }
}

Example:

{
  "touch_identifier": "fM2RzZmdhNHczIDVxMjM=",
  "identity": "vDS4dc29tZWlkZW50aWZlcg",
  "identity_source": "tracking",
  "matched_segments": [
    {
      "id": "10092",
      "name": "Anonymous Visitor",
      "description": "Tracks whether a visitor to the site is anonymous"
    },
    {
      "id": "10096",
      "name": "Interested Visitor",
      "description": "If the new user clicks on the aboutus section of the site, then they are an interested visitor learning more about the service."
    }
  ],
  "content_interactions": [
    {
      "content_uuid": "9c41a106ee4d41df89cd9",
      "type": "CONTENT_VIEW",
      "date_time": "2017-07-25T20:25:14.01"
    },
    {
      "content_uuid": "6de3188b01e5442daa03e",
      "type": "CONTENT_VIEW",
      "date_time": "2017-07-25T20:25:47.657"
    }
  ]
}

HTTP status code 400

Missing captures parameter, no captures, invalid identity_source, invalid site_id, invalid event_date, invalid JSON.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/error.json",
  "title": "Generic error schema",
  "type": "object",
  "item": {
    "title": "Generic error",
    "type": "object",
    "properties": {
      "status": {
        "description": "Various endpoint request STATUS when it has returned an error (HTTP 4xx/5xx).",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the endpoint request failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

[
  {
    "touch_identifier": "45f932c510764f42cpc4f",
    "identity": "sample@acquia.com",
    "identity_source": "email",
    "errors": [
      {
        "code": "BAD_REQUEST",
        "message": "Customer site is not valid, 'SAMPLE_SITE' not found for customer 'TESTACCOUNT'"
      }
    ]
  },
  {
    "touch_identifier": "54971e18afe2191a96652",
    "identity": "sample2@acquia.com",
    "identity_source": "email",
    "errors": [
      {
        "code": "BAD_REQUEST",
        "message": "No captures provided"
      }
    ]
  },
  {
    "touch_identifier": "ecb7390f605e4018849dj",
    "identity": "sample3@acquia.com",
    "identity_source": "invalidIdentitySource",
    "errors": [
      {
        "code": "BAD_REQUEST",
        "message": "Invalid identity source, 'invalidIdentitySource' not found for customer 'QAIT'"
      }
    ]
  },
  {
    "touch_identifier": "696Gg0yO5Swi60nwMyZRx0",
    "identity": "1T92JgHAEqgHPPKsDG4ihN",
    "identity_source": "tracking",
    "errors": [
      {
        "code": "BAD_REQUEST",
        "message": "No data provided"
      }
    ]
  },
  {
    "touch_identifier": "2771861397f24d25b64ee",
    "identity": "792JgHAEqgHPPKsDG4ihN",
    "identity_source": "tracking",
    "errors": [
      {
        "code": "BAD_REQUEST",
        "message": "Invalid capture data - Date type custom field(s) in invalid format for capture 1"
      },
      {
        "code": "BAD_REQUEST",
        "message": "No valid captures provided"
      }
    ]
  },
  {
    "touch_identifier": "a59749d7410c372e8cadf",
    "identity": "HAEqgH792JgPPKsDG4ihN",
    "identity_source": "tracking",
    "errors": [
      {
        "code": "DATE_FORMAT_INCORRECT",
        "message": "Invalid date format for capture 1"
      },
      {
        "code": "BAD_REQUEST",
        "message": "No valid captures provided"
      }
    ]
  }
]

HTTP status code 429

Limit exceeded for either max touches per person in a month or max events per touch.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/error.json",
  "title": "Generic error schema",
  "type": "object",
  "item": {
    "title": "Generic error",
    "type": "object",
    "properties": {
      "status": {
        "description": "Various endpoint request STATUS when it has returned an error (HTTP 4xx/5xx).",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the endpoint request failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

[
  {
    "touch_identifier": "ecb7390f605e4018849dj",
    "identity": "sample3@acquia.com",
    "identity_source": "tracking",
    "errors": [
      {
        "code": "LIMIT_EXCEEDED",
        "message": "Max touches per person in a month limit exceeded"
      }
    ]
  },
  {
    "touch_identifier": "ecb7390f605e4018849dj",
    "identity": "sample3@acquia.com",
    "identity_source": "tracking",
    "errors": [
      {
        "code": "LIMIT_EXCEEDED",
        "message": "Max events per touch limit exceeded"
      }
    ]
  }
]

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

The known profile was updated successfully with the specified identifiers.

HTTP status code 400

Missing or invalid parameter values.

HTTP status code 404

The known profile (identifier + type) is not found for the customer account.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

All identities specified in the payload were deleted

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/capture_identity_delete_response.json",
  "title": "Capture identity",
  "type": "object",
  "item": {
    "title": "Capture Identity",
    "type": "object",
    "properties": {
      "status": {
        "description": "Capture Identity request status. SUCCESS if all identities were deleted, COMPLETED_WITH_ERRORS if some identities were deleted or, FAILURE otherwise",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for capture_identity DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the capture_identity endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      },
      "deletedIdentities": {
        "description": "List of identities that were deleted",
        "type": "array",
        "items": {
          "pattern": "^[a-z0-9_-]{1,128}$",
          "type": "string"
        }
      }
    },
    "required": [
      "status"
    ]
  }
}

Example:

[
  {
    "status": "SUCCESS",
    "deleted_identities": [
      "example_name",
      "example_facebook",
      "@example"
    ]
  },
  {
    "deleted_identities": [
      "some_email@example.com"
    ],
    "errors": [
      {
        "message": "Identity 5gbtzFkDsbknwyGY8YE63R of type tracking is not allowed to be deleted",
        "statusCode": "INVALID_IDENTITY"
      }
    ],
    "status": "COMPLETED_WITH_ERRORS"
  }
]

HTTP status code 400

Deleting a tracking id, invalid JSON

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/capture_identity_delete_response.json",
  "title": "Capture identity",
  "type": "object",
  "item": {
    "title": "Capture Identity",
    "type": "object",
    "properties": {
      "status": {
        "description": "Capture Identity request status. SUCCESS if all identities were deleted, COMPLETED_WITH_ERRORS if some identities were deleted or, FAILURE otherwise",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for capture_identity DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the capture_identity endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      },
      "deletedIdentities": {
        "description": "List of identities that were deleted",
        "type": "array",
        "items": {
          "pattern": "^[a-z0-9_-]{1,128}$",
          "type": "string"
        }
      }
    },
    "required": [
      "status"
    ]
  }
}

Example:

[
  {
    "errors": [
      {
        "message": "Identity some_tracking_id of type tracking is not allowed to be deleted",
        "statusCode": "INVALID_IDENTITY"
      }
    ],
    "status": "FAILURE"
  },
  {
    "errors": [
      {
        "message": "Missing knownIdentifier from the request",
        "statusCode": "MISSING_KNOWN_IDENTIFIER"
      },
      {
        "message": "Missing knownIdentifierType from the request",
        "statusCode": "MISSING_KNOWN_IDENTIFIER_TYPE"
      }
    ],
    "status": "FAILURE"
  }
]

HTTP status code 404

Unable to find identifier(s) to delete or when the known identifier is not found

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/capture_identity_delete_response.json",
  "title": "Capture identity",
  "type": "object",
  "item": {
    "title": "Capture Identity",
    "type": "object",
    "properties": {
      "status": {
        "description": "Capture Identity request status. SUCCESS if all identities were deleted, COMPLETED_WITH_ERRORS if some identities were deleted or, FAILURE otherwise",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for capture_identity DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the capture_identity endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      },
      "deletedIdentities": {
        "description": "List of identities that were deleted",
        "type": "array",
        "items": {
          "pattern": "^[a-z0-9_-]{1,128}$",
          "type": "string"
        }
      }
    },
    "required": [
      "status"
    ]
  }
}

Example:

{
  "errors": [
    {
      "message": "Identity example_name of type name is not found",
      "statusCode": "IDENTITY_NOT_FOUND"
    }
  ],
  "status": "FAILURE"
}

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 201

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/customer_sites_response.json",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "status": {
        "description": "Customer site post status. SUCCESS if succeeded, FAILURE otherwise",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for the customer site post.",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the post failed.",
          "type": "object",
          "properties": {
            "code": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            },
            "message": {
              "description": "Human readable error message.",
              "type": "string",
              "maxLength": 200
            }
          }
        },
        "minItems": 0
      },
      "item": {
        "description": "Customer site object that was passed to the api.",
        "type": "object",
        "properties": {
          "id": {
            "description": "Customer Site UID.",
            "type": "string",
            "maxLength": 20
          },
          "name": {
            "description": "Name of the customer site.",
            "type": "string",
            "maxLength": 50
          },
          "url": {
            "description": "URL of the customer site.",
            "type": "string",
            "maxLength": 2000
          }
        }
      }
    },
    "required": [
      "status",
      "item"
    ]
  }
}

Example:

[
  {
    "status": "SUCCESS",
    "item": {
      "id": "lift_web",
      "name": "Lift Web",
      "url": "http://lift.acquia.com"
    }
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "code": "INVALID_NAME",
        "message": "Customer Site name is mandatory"
      }
    ],
    "item": {
      "id": "content_hub",
      "name": ""
    }
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "code": "INVALID_UID",
        "message": "Customer site id must not contain any whitespaces"
      }
    ],
    "item": {
      "id": "site db61a017938545h",
      "name": "name-db61a017938545h",
      "url": "https://docs.acquia.com/lift/profile-mgr"
    }
  }
]

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/customer_site.json",
  "type": "object",
  "properties": {
    "id": {
      "description": "Customer Site UID.",
      "type": "string",
      "maxLength": 20
    },
    "name": {
      "description": "Name of the customer site.",
      "type": "string",
      "maxLength": 50
    },
    "url": {
      "description": "URL of the customer site.",
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "id",
    "name"
  ]
}

Example:

{
  "id": "lift_web",
  "name": "Lift Web",
  "url": "http://lift.acquia.com"
}

HTTP status code 404

Customer site not found.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

Customer site deleted.

HTTP status code 404

Customer site not found.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 201

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/event_import_response.json",
  "type": "object",
  "title": "Event Import",
  "description": "Event Import Response.",
  "required": [
    "event_import_status_url",
    "event_import_id"
  ],
  "properties": {
    "errors": {
      "description": "List of errors for the event_import post.",
      "type": "array",
      "items": {
        "description": "Error object containing information on errors in the event imports.",
        "type": "object",
        "properties": {
          "code": {
            "description": "Error code.",
            "type": "string",
            "maxLength": 100
          },
          "message": {
            "description": "Human readable error message.",
            "type": "string",
            "maxLength": 200
          }
        }
      },
      "minItems": 0
    },
    "event_import_status_url": {
      "type": "string",
      "description": "The URL of your Acquia Lift-related files."
    },
    "event_import_id": {
      "type": "integer",
      "description": "Unique identifier assigned by Acquia Lift to the events."
    }
  }
}

Example:

[
  {
    "event_import_status_url": "http://us-east-1-production-api.lift.acquia.com/SAMPLE/event_import_status/10601",
    "event_import_id": 10601
  },
  {
    "event_import_status_url": "http://us-east-1-production-api.lift.acquia.com/SAMPLE/event_import_status/10603",
    "event_import_id": 10603,
    "error": "One or more rows were not imported, to check status please visit eventImportStatusURL"
  }
]

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/event_import_status_response.json",
  "type": "object",
  "title": "Event Import Status",
  "description": "event import status.",
  "properties": {
    "eventImportID": {
      "type": "integer",
      "description": "Unique identifier assigned by Acquia Lift to the event import process."
    },
    "status": {
      "type": "string",
      "description": "Status of the event import process - COMPLETED or ERROR."
    },
    "totalNumberOfLines": {
      "type": "integer",
      "description": "The number of lines/records registered in the data specified."
    },
    "numberOfRejectedLines": {
      "type": "integer",
      "description": "The number of lines/records that were not processed."
    },
    "numberOfProcessedLines": {
      "type": "integer",
      "description": "The number of lines/records that were processed successfully."
    },
    "creationTime": {
      "type": "string",
      "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9].[0-9]{1,3}Z$",
      "description": "The date and time that the import process was started (e.g., 2015-12-07T20:43:43.639Z)."
    },
    "completionTime": {
      "type": "string",
      "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9].[0-9]{1,3}Z$",
      "description": "The date and time that the import process was finished (e.g., 2015-12-07T20:43:46.021Z)."
    },
    "rejectedLines": {
      "type": "array",
      "minItems": 0,
      "uniqueItems": true
    }
  }
}

Example:

[
  {
    "eventImportID": 17204,
    "status": "COMPLETED",
    "totalNumberOfLines": 1,
    "numberOfRejectedLines": 0,
    "numberOfProcessedLines": 1,
    "creationTime": "2015-12-07T20:43:43.639Z",
    "completionTime": "2015-12-07T20:43:46.021Z",
    "rejectedLines": []
  },
  {
    "eventImportID": 3390116,
    "status": "SUBMITTED",
    "totalNumberOfLines": 1,
    "numberOfRejectedLines": 1,
    "numberOfProcessedLines": 1,
    "creationTime": "2018-05-02T02:43:58.727Z",
    "rejectedLines": [
      {
        "eventImportId": 3390116,
        "lineNumber": 0,
        "lineStatus": "ERROR",
        "processTime": "2018-05-02T02:43:58Z",
        "lineContent": "{\"identity\":\"sample@acquia.com\",\"identity_source\":\"email\",\"event_source\":\"API\"}",
        "error": "MISMATCHED_NUMBER_OF_COLUMNS",
        "internalError": "Row is missing a necessary parameter or has an incorrect type"
      }
    ]
  }
]

HTTP status code 404

Event Import Status ID was not found.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 202

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/export_visitor_data_response.json",
  "type": "array",
  "title": "Export Visitor Data",
  "items": {
    "title": "ExportVisitorDataResponse",
    "type": "object",
    "required": [
      "id",
      "location",
      "statusURL"
    ],
    "properties": {
      "id": {
        "type": "integer",
        "description": "Unique combination of numbers identifying the person data export file — Acquia Lift Profile Manager internal value."
      },
      "location": {
        "type": "string",
        "description": "The location of the exported file in the filesystem."
      },
      "statusURL": {
        "type": "string",
        "description": "The Acquia Lift Profile Manager URL where the status information can be viewed."
      }
    }
  }
}

Example:

[
  {
    "id": 17203,
    "location": "SAMPLE/OUTBOX/person_2015-10-30_17203.csv",
    "statusURL": "https://eu-central-1-qa-my.dev.lift.acquia.com:443/SAMPLE/export_visitor_data_status/17203"
  },
  {
    "id": 17205,
    "location": "SAMPLE/OUTBOX/rankings_2015-10-30_17205.csv",
    "statusURL": "https://eu-central-1-qa-my.dev.lift.acquia.com:443/SAMPLE/export_visitor_data_status/17205"
  },
  {
    "id": 17204,
    "location": "SAMPLE/OUTBOX/matchedsegment_2015-10-30_17204.csv",
    "statusURL": "https://eu-central-1-qa-my.dev.lift.acquia.com:443/SAMPLE/export_visitor_data_status/17204"
  },
  {
    "id": 17206,
    "location": "SAMPLE/OUTBOX/touch_2015-10-30_17206.csv",
    "statusURL": "https://eu-central-1-qa-my.dev.lift.acquia.com:443/SAMPLE/export_visitor_data_status/17206"
  },
  {
    "id": 17208,
    "location": "SAMPLE/OUTBOX/event_2015-10-30_17208.csv",
    "statusURL": "https://eu-central-1-qa-my.dev.lift.acquia.com:443/SAMPLE/export_visitor_data_status/17208"
  },
  {
    "id": 17207,
    "location": "SAMPLE/OUTBOX/segment_2015-10-30_17207.csv",
    "statusURL": "https://eu-central-1-qa-my.dev.lift.acquia.com:443/SAMPLE/export_visitor_data_status/17207"
  },
  {
    "id": 17209,
    "location": "SAMPLE/OUTBOX/segment_2015-10-30_2015_11_31_17209.csv",
    "statusURL": "https://eu-central-1-qa-my.dev.lift.acquia.com:443/SAMPLE/export_visitor_data_status/17209"
  }
]

HTTP status code 400

Body

Media type: application/json

Type: export_visitor_data_response_400.json

Example:

{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "INVALID_DATA_EXPORT",
      "message": "The data export 'invalid' is not valid for this request."
    },
    {
      "statusCode": "INVALID_DATE_RANGE",
      "message": "The date range '2018-07-12 15:48:43.765, 2018-07-11 15:48:43.765' is not valid."
    },
    {
      "statusCode": "INVALID_DATE_RANGE",
      "message": "The start date '2018-07' is not valid."
    },
    {
      "statusCode": "INVALID_IDENTIFIER_TYPE",
      "message": "The identifier type 'invalid' is not valid for this customer account."
    },
    {
      "statusCode": "MISSING_START_DATE",
      "message": "The start date parameter is missing for this request."
    },
    {
      "statusCode": "MISSING_DATA_EXPORT",
      "message": "The data export parameter is missing for this request."
    }
  ]
}

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/export_visitor_data_status_response.json",
  "type": "object",
  "title": "Export Visitor Data Status",
  "description": "Export Visitor Data Status Response.",
  "required": [
    "id",
    "status",
    "completionTime"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique combination of numbers identifying the person data export file — Acquia Lift Profile Manager internal value."
    },
    "status": {
      "type": "string",
      "description": "Status of the current export — possible statuses include Submitted, Completed, and Completed - Errors."
    },
    "completionTime": {
      "type": "string",
      "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9].[0-9]{3}Z$",
      "description": "The date and time that the data file finished the export process (e.g., 2015-11-05T21:01:42.239Z)."
    }
  }
}

Example:

{
  "id": 17104,
  "status": "Completed",
  "completionTime": "2015-11-05T21:01:42.239Z"
}

HTTP status code 303

Export job may be found under another URI.

HTTP status code 404

Resource not found.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/goals.json",
  "title": "Goals",
  "type": "array",
  "items": {
    "title": "Goal",
    "type": "object",
    "properties": {
      "id": {
        "description": "Goal UID.",
        "type": "string",
        "maxLength": 100
      },
      "name": {
        "description": "Human readable name of the goal.",
        "type": "string",
        "maxLength": 200
      },
      "description": {
        "description": "Description of the goal.",
        "type": "string",
        "maxLength": 4000
      },
      "rule_ids": {
        "description": "Rule identifiers.",
        "type": "array",
        "items": {
          "type": "string",
          "pattern": "^[a-z0-9_-]{1,128}$"
        },
        "minItems": 0,
        "uniqueItems": true
      },
      "event_names": {
        "description": "One or more event names.",
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 200
        },
        "minItems": 1,
        "uniqueItems": true
      },
      "global": {
        "description": "Indicates whether goal is global.",
        "type": "boolean"
      },
      "site_ids": {
        "description": "Optional list of site ids. Required if global is false.",
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 20,
          "description": "The customer site matching external_site_id in the configuration database."
        },
        "minItems": 1,
        "uniqueItems": true
      },
      "value": {
        "description": "Empty or numeric value (float).",
        "type": "string"
      }
    },
    "required": [
      "id",
      "name",
      "description",
      "event_names",
      "global"
    ]
  }
}

Example:

[
  {
    "id": "pDX4dc29tZWlkZW50aWZlcg",
    "name": "Purchase",
    "description": "Winter promotion",
    "rule_ids": [
      "rule-1",
      "rule-2"
    ],
    "event_names": [
      "purchase"
    ],
    "global": false,
    "site_ids": [
      "us",
      "ca"
    ],
    "value": "100"
  },
  {
    "id": "kZW50aWZlcg9tZWlkZW50lcg",
    "name": "Subscribe",
    "description": "Mailing list",
    "rule_ids": [
      "rule-3",
      "rule-4"
    ],
    "event_names": [
      "form_submit"
    ],
    "global": false,
    "site_ids": [
      "us",
      "ca"
    ],
    "value": "50"
  }
]

HTTP status code 400

If an invalid customer site is passed in the site_id parameter.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 201

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/goalspostresult.json",
  "title": "Goals",
  "type": "array",
  "items": {
    "title": "GoalPostResult",
    "type": "object",
    "properties": {
      "status": {
        "description": "Goal post status. SUCCESS if succeeded, FAILURE otherwise.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for the goal post.",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the post failed.",
          "type": "object",
          "properties": {
            "code": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            },
            "message": {
              "description": "Human readable error message.",
              "type": "string",
              "maxLength": 200
            }
          }
        },
        "minItems": 0
      },
      "item": {
        "description": "Goal object that was passed to the api.",
        "type": "object",
        "properties": {
          "id": {
            "description": "Goal UID.",
            "type": "string",
            "maxLength": 100
          },
          "name": {
            "description": "Human readable name of the goal.",
            "type": "string",
            "maxLength": 200
          },
          "description": {
            "description": "Description of the goal.",
            "type": "string",
            "maxLength": 4000
          },
          "rule_ids": {
            "description": "Rule identifiers.",
            "type": "array",
            "items": {
              "type": "string",
              "pattern": "^[a-z0-9_-]{1,128}$"
            },
            "minItems": 0,
            "uniqueItems": true
          },
          "event_names": {
            "description": "One or more event names.",
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 200
            },
            "minItems": 0,
            "uniqueItems": true
          },
          "global": {
            "description": "Indicates whether goal is global.",
            "type": "boolean"
          },
          "site_ids": {
            "description": "List of site ids.",
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 20,
              "description": "The customer site matching external_site_id in configuration database."
            },
            "minItems": 0,
            "uniqueItems": true
          },
          "value": {
            "description": "Empty or numeric value (float).",
            "type": "string"
          }
        }
      }
    },
    "required": [
      "status",
      "item"
    ]
  }
}

Example:

[
  {
    "status": "SUCCESS",
    "item": {
      "id": "pDX4dc29tZWlkZW50aWZlcg",
      "name": "Purchase",
      "description": "Winter promotion",
      "rule_ids": [
        "rule-1",
        "rule-2"
      ],
      "event_names": [
        "purchase"
      ],
      "global": true,
      "value": "100"
    }
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "code": "DUPLICATED_NAME",
        "message": "Goal with the same name already exists"
      },
      {
        "code": "INVALID_SITE_ID",
        "message": "Invalid site provided"
      }
    ],
    "item": {
      "id": "kZW50aWZlcg9tZWlkZW50lcg",
      "name": "Subscribe",
      "description": "Mailing list",
      "rule_ids": [
        "rule-3",
        "rule-4"
      ],
      "event_names": [
        "form_submit"
      ],
      "global": false,
      "site_ids": [
        "us",
        "ca"
      ],
      "value": "50"
    }
  }
]

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/goal.json",
  "title": "Goal",
  "type": "object",
  "properties": {
    "id": {
      "description": "Goal UID.",
      "type": "string",
      "maxLength": 100
    },
    "name": {
      "description": "Human readable name of the goal.",
      "type": "string",
      "maxLength": 200
    },
    "description": {
      "description": "Description of the goal.",
      "type": "string",
      "maxLength": 4000
    },
    "rule_ids": {
      "description": "Rule identifiers.",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[a-z0-9_-]{1,128}$"
      },
      "minItems": 0,
      "uniqueItems": true
    },
    "event_names": {
      "description": "One or more event names.",
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 200
      },
      "minItems": 1,
      "uniqueItems": true
    },
    "global": {
      "description": "Indicates whether goal is global.",
      "type": "boolean"
    },
    "site_ids": {
      "description": "Optional list of site ids. Required if global is false.",
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 20,
        "description": "The customer site matching external_site_id in the configuration database."
      },
      "minItems": 0,
      "uniqueItems": true
    },
    "value": {
      "description": "Empty or numeric value (float).",
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "event_names",
    "global"
  ]
}

Example:

{
  "id": "pDX4dc29tZWlkZW50aWZlcg",
  "name": "Purchase",
  "description": "Winter promotion",
  "rule_ids": [
    "rule-1",
    "rule-2"
  ],
  "event_names": [
    "purchase"
  ],
  "global": false,
  "site_ids": [
    "us",
    "ca"
  ],
  "value": "100"
}

HTTP status code 404

Goal not found.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

Goal deleted.

HTTP status code 404

Goal not found.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

Version 1 returns only the segment IDs.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/segments_v1.json",
  "title": "Segments",
  "type": "array",
  "items": {
    "title": "Segment",
    "type": "string",
    "properties": {
      "id": {
        "description": "Segment Id.",
        "type": "string",
        "maxLength": 100
      }
    }
  }
}

Example:

[
  "Anyone",
  "CanadaVisitors",
  "DeveloperPersona"
]

HTTP status code 400

If an invalid customer site is passed in the site_id parameter.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/users.json",
  "title": "Users",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Get all users request status. SUCCESS if succeeded, FAILURE otherwise",
        "type": "string",
        "maxLength": 10
      },
      "total": {
        "description": "Count of total users matching criteria passed in query params",
        "type": "int"
      },
      "errors": {
        "description": "List of errors for users get",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the get failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "code": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 0
      },
      "item": {
        "description": "List of users that is passed to api.",
        "type": "array",
        "item": {
          "description": "User object that is passed to api",
          "type": "object",
          "properties": {
            "userId": {
              "description": "User UID.",
              "type": "string",
              "maxLength": 100
            },
            "fullName": {
              "description": "Full name of the user.",
              "type": "string",
              "maxLength": 200
            },
            "enabled": {
              "description": "If this user is enabled or not",
              "type": "boolean"
            },
            "emailAddress": {
              "description": "Email of the user. Used for login.",
              "type": "string",
              "maxLength": 200
            },
            "plainPassword": {
              "description": "User password.",
              "type": "string",
              "maxLength": 100
            },
            "secGroupId": {
              "description": "The id of the security group this user belongs to. Reverse lookup is available using the /usergroups endpoint.",
              "type": "int"
            },
            "accessKeyId": {
              "description": "The user's access key for accessing the API.",
              "type": "string"
            },
            "secretAccessKey": {
              "description": "The user's secret access key for accessing the API.",
              "type": "string"
            },
            "plainTextResetToken": {
              "description": "Password reset token for user. Internal use only.",
              "type": "String"
            },
            "passwordChangeRequired": {
              "description": "If this user is required to change their password upon their next login.",
              "type": "boolean"
            },
            "sendEmail": {
              "description": "Whether or not an email should be sent to the user's email address upon creation.",
              "type": "boolean"
            },
            "resetTokenGenerationDate": {
              "description": "The date that the reset token is generated",
              "type": "date"
            },
            "links": {
              "description": "Reference link for current resource",
              "type": "object",
              "properties": {
                "rel": {
                  "description": "The object that the link is related to.",
                  "type": "string"
                },
                "href": {
                  "description": "Reference link for current object.",
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "required": [
      "status"
    ]
  }
}

Example:

[
  {
    "status": "SUCCESS",
    "total": 3,
    "item": [
      {
        "object": "user",
        "userId": "VGVzdC5hcGl1c2VyQGFjcXVpYS5jb20=",
        "fullName": "Anonymous API User",
        "enabled": true,
        "emailAddress": "Test.apiuser@acquia.com",
        "plainPassword": null,
        "secGroupId": 39,
        "accessKeyId": "1234asdfb",
        "secretAccessKey": "abc123",
        "plainTextResetToken": null,
        "passwordChangeRequired": false,
        "sendEmail": false,
        "resetTokenGenerationDate": null,
        "links": [
          {
            "rel": "self",
            "href": "https://us-east-1-api.lift.acquia.com/api/v1/accounts/Test/users/VGVzdC5hcGl1c2VyQGFjcXVpYS5jb20="
          }
        ]
      },
      {
        "object": "user",
        "userId": "VGVzdC5jb250ZW50aHViQGFjcXVpYS5jb20=",
        "fullName": "Content Hub Admin User",
        "enabled": true,
        "emailAddress": "Test.contenthub@acquia.com",
        "plainPassword": null,
        "secGroupId": 41,
        "accessKeyId": "1234asdfb",
        "secretAccessKey": "abc123",
        "plainTextResetToken": null,
        "passwordChangeRequired": false,
        "sendEmail": false,
        "resetTokenGenerationDate": null,
        "links": [
          {
            "rel": "self",
            "href": "https://us-east-1-api.lift.acquia.com/api/v1/accounts/Test/users/VGVzdC5jb250ZW50aHViQGFjcXVpYS5jb20="
          }
        ]
      },
      {
        "object": "user",
        "userId": "VGVzdC5mdWxsYXBpQGFjcXVpYS5jb20=",
        "fullName": "Full API User",
        "enabled": true,
        "emailAddress": "Test.fullapi@acquia.com",
        "plainPassword": null,
        "secGroupId": 42,
        "accessKeyId": "1234asdfb",
        "secretAccessKey": "abc123",
        "plainTextResetToken": null,
        "passwordChangeRequired": false,
        "sendEmail": false,
        "resetTokenGenerationDate": null,
        "links": [
          {
            "rel": "self",
            "href": "https://us-east-1-api.lift.acquia.com/api/v1/accounts/Test/users/VGVzdC5mdWxsYXBpQGFjcXVpYS5jb20="
          }
        ]
      }
    ]
  }
]

HTTP status code 403

The user credentials or the account are not permitted to use this endpoint.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/users_4xx.json",
  "title": "Users",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Users endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for users POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the users endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

{
  "status": "FAILURE",
  "errors": [
    {
      "message": "No permission to perform operations for the account provided",
      "statusCode": "INVALID_ACCOUNTNAME"
    }
  ]
}

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 201

The user was created successfully.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/userpostresult.json",
  "title": "User Post Result",
  "type": "object",
  "item": {
    "title": "User",
    "type": "object",
    "properties": {
      "status": {
        "description": "Create user request status. SUCCESS if succeeded, FAILURE otherwise",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for user post",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the post failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "code": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 0
      },
      "item": {
        "description": "User object that is created.",
        "type": "object",
        "properties": {
          "userId": {
            "description": "User UID.",
            "type": "string",
            "maxLength": 100
          },
          "fullName": {
            "description": "Full name of the user.",
            "type": "string",
            "maxLength": 200
          },
          "enabled": {
            "description": "If this user is enabled or not",
            "type": "boolean"
          },
          "emailAddress": {
            "description": "Email of the user. Used for login.",
            "type": "string",
            "maxLength": 200
          },
          "plainPassword": {
            "description": "User password.",
            "type": "string",
            "maxLength": 100
          },
          "secGroupId": {
            "description": "The id of the security group this user belongs to. Reverse lookup is available using the /usergroups endpoint.",
            "type": "int"
          },
          "accessKeyId": {
            "description": "The user's access key for accessing the API.",
            "type": "string"
          },
          "secretAccessKey": {
            "description": "The user's secret access key for accessing the API.",
            "type": "string"
          },
          "plainTextResetToken": {
            "description": "Password reset token for user. Internal use only.",
            "type": "String"
          },
          "passwordChangeRequired": {
            "description": "If this user is required to change their password upon their next login.",
            "type": "boolean"
          },
          "sendEmail": {
            "description": "Whether or not an email should be sent to the user's email address upon creation.",
            "type": "boolean"
          },
          "resetTokenGenerationDate": {
            "description": "The date that the reset token is generated",
            "type": "date"
          },
          "links": {
            "description": "Reference link for current resource",
            "type": "object",
            "properties": {
              "rel": {
                "description": "The object that the link is related to.",
                "type": "string"
              },
              "href": {
                "description": "Reference link for current object.",
                "type": "string"
              }
            }
          }
        }
      }
    },
    "required": [
      "status"
    ]
  }
}

Example:

[
  {
    "status": "SUCCESS",
    "item": {
      "object": "user",
      "id": "VGVzdC5hcGl1c2VyQGFjcXVpYS5jb20=",
      "fullName": "Tom Cruise",
      "enabled": true,
      "email": "tom@example.com",
      "plainPassword": null,
      "secGroupId": 40,
      "accessKeyId": "1234asdfb",
      "secretAccessKey": "abc123",
      "plainTextResetToken": null,
      "passwordChangeRequired": false,
      "sendEmail": false,
      "resetTokenGenerationDate": null,
      "links": [
        {
          "rel": "self",
          "href": "https://us-east-1-api.lift.acquia.com/api/v1/accounts/Test/users/VGVzdC5hcGl1c2VyQGFjcXVpYS5jb20="
        }
      ]
    }
  }
]

HTTP status code 400

If request payload is not valid (missing parameter/invalid parameters).

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/users_4xx.json",
  "title": "Users",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Users endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for users POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the users endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

[
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "Missing email for creating user request",
        "statusCode": "MISSING_EMAIL"
      }
    ]
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "Missing fullname for updating user request",
        "statusCode": "MISSING_FULLNAME"
      }
    ]
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "Missing group id for updating user request",
        "statusCode": "MISSING_GROUP_ID"
      }
    ]
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "Missing password for updating user request",
        "statusCode": "MISSING_PASSWORD"
      }
    ]
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "User with the same email already exists",
        "statusCode": "DUPLICATED_EMAIL"
      }
    ]
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "Password does not meet security constraints",
        "statusCode": "INVALID_PASSWORD"
      }
    ]
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "User security group -1 does not exist for this account",
        "statusCode": "INVALID_GROUP_ID"
      }
    ]
  }
]

HTTP status code 403

The user credentials or the account are not permitted to use this endpoint.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/users_4xx.json",
  "title": "Users",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Users endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for users POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the users endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

{
  "status": "FAILURE",
  "errors": [
    {
      "message": "No permission to perform operations for the account provided",
      "statusCode": "INVALID_ACCOUNTNAME"
    }
  ]
}

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/user.json",
  "title": "User",
  "type": "object",
  "item": {
    "title": "User",
    "type": "object",
    "properties": {
      "status": {
        "description": "Get user request status. SUCCESS if succeeded, FAILURE otherwise",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for users get for an individual user",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the get failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "code": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 0
      },
      "item": {
        "description": "User object that is passed to the api.",
        "type": "object",
        "properties": {
          "userId": {
            "description": "User UID.",
            "type": "string",
            "maxLength": 100
          },
          "fullName": {
            "description": "Full name of the user.",
            "type": "string",
            "maxLength": 200
          },
          "enabled": {
            "description": "If this user is enabled or not.",
            "type": "boolean"
          },
          "emailAddress": {
            "description": "Email of the user. Used for login.",
            "type": "string",
            "maxLength": 200
          },
          "plainPassword": {
            "description": "User password.",
            "type": "string",
            "maxLength": 100
          },
          "secGroupId": {
            "description": "The id of the security group this user belongs to. Reverse lookup is available using the /usergroups endpoint.",
            "type": "int"
          },
          "accessKeyId": {
            "description": "The user's access key for accessing the API.",
            "type": "string"
          },
          "secretAccessKey": {
            "description": "The user's secret access key for accessing the API.",
            "type": "string"
          },
          "plainTextResetToken": {
            "description": "Password reset token for user. Internal use only.",
            "type": "String"
          },
          "passwordChangeRequired": {
            "description": "If this user is required to change their password upon their next login.",
            "type": "boolean"
          },
          "sendEmail": {
            "description": "Whether or not an email should be sent to the user's email address upon creation.",
            "type": "boolean"
          },
          "resetTokenGenerationDate": {
            "description": "The date that the reset token is generated",
            "type": "date"
          },
          "links": {
            "description": "Reference link for current resource",
            "type": "object",
            "properties": {
              "rel": {
                "description": "The object that the link is related to.",
                "type": "string"
              },
              "href": {
                "description": "Reference link for current object.",
                "type": "string"
              }
            }
          }
        }
      }
    },
    "required": [
      "status"
    ]
  }
}

Example:

[
  {
    "status": "SUCCESS",
    "item": [
      {
        "object": "user",
        "id": "VGVzdC5hcGl1c2VyQGFjcXVpYS5jb20=",
        "fullName": "Tom Cruise",
        "enabled": true,
        "email": "tom@example.com",
        "plainPassword": null,
        "secGroupId": 40,
        "accessKeyId": "1234asdfb",
        "secretAccessKey": "abc123",
        "plainTextResetToken": null,
        "passwordChangeRequired": false,
        "sendEmail": false,
        "resetTokenGenerationDate": null,
        "links": [
          {
            "rel": "self",
            "href": "https://us-east-1-api.lift.acquia.com/api/v1/accounts/Test/users/VGVzdC5hcGl1c2VyQGFjcXVpYS5jb20="
          }
        ]
      }
    ]
  }
]

HTTP status code 400

If request payload is invalid (missing parameter / invalid parameters).

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/users_4xx.json",
  "title": "Users",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Users endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for users POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the users endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

[
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "Missing fullname for updating user request",
        "statusCode": "MISSING_FULLNAME"
      }
    ]
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "Missing group id for updating user request",
        "statusCode": "MISSING_GROUP_ID"
      }
    ]
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "Password does not meet security constraints",
        "statusCode": "INVALID_PASSWORD"
      }
    ]
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "User security group -1 does not exist for this account",
        "statusCode": "INVALID_GROUP_ID"
      }
    ]
  },
  {
    "status": "FAILED",
    "errors": [
      {
        "statusCode": "UNSUPPORTED_ARGUMENT",
        "message": "Unsupported Argument - Cannot decode user identifier: 01254601b4444c68ad764"
      }
    ]
  }

]

HTTP status code 403

The user credentials or the account are not permitted to use this endpoint.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/users_4xx.json",
  "title": "Users",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Users endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for users POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the users endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

{
  "status": "FAILURE",
  "errors": [
    {
      "message": "No permission to perform operations for the account provided",
      "statusCode": "INVALID_ACCOUNTNAME"
    }
  ]
}

HTTP status code 404

User not found.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/users_4xx.json",
  "title": "Users",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Users endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for users POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the users endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

[
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "User is not found",
        "statusCode": "INVALID_USER_ID"
      }
    ]
  }
]

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

Body

Media type: application/json

Type: usersputresult

Example:

[
  {
    "status": "SUCCESS",
    "item": {
      "object": "user",
      "id": "VGVzdC5hcGl1c2VyQGFjcXVpYS5jb20=",
      "fullName": "Tom Cruise",
      "enabled": true,
      "email": "tom@example.com",
      "plainPassword": null,
      "secGroupId": 40,
      "accessKeyId": "1234asdfb",
      "secretAccessKey": "abc123",
      "plainTextResetToken": null,
      "passwordChangeRequired": false,
      "sendEmail": false,
      "resetTokenGenerationDate": null,
      "links": [
        {
          "rel": "self",
          "href": "https://us-east-1-api.lift.acquia.com/api/v1/accounts/Test/users/VGVzdC5hcGl1c2VyQGFjcXVpYS5jb20="
        }
      ]
    }
  }
]

HTTP status code 400

If request payload is not valid (missing parameter/invalid parameters).

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/users_4xx.json",
  "title": "Users",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Users endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for users POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the users endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

[
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "Missing fullname for updating user request",
        "statusCode": "MISSING_FULLNAME"
      }
    ]
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "Missing group id for updating user request",
        "statusCode": "MISSING_GROUP_ID"
      }
    ]
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "Password does not meet security constraints",
        "statusCode": "INVALID_PASSWORD"
      }
    ]
  },
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "User security group -1 does not exist for this account",
        "statusCode": "INVALID_GROUP_ID"
      }
    ]
  },
  {
    "status": "FAILED",
    "errors": [
      {
        "statusCode": "UNSUPPORTED_ARGUMENT",
        "message": "Unsupported Argument - Cannot decode user identifier: 01254601b4444c68ad764"
      }
    ]
  }

]

HTTP status code 403

The user credentials or the account are not permitted to use this endpoint.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/users_4xx.json",
  "title": "Users",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Users endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for users POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the users endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

{
  "status": "FAILURE",
  "errors": [
    {
      "message": "No permission to perform operations for the account provided",
      "statusCode": "INVALID_ACCOUNTNAME"
    }
  ]
}

HTTP status code 404

User not found.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/users_4xx.json",
  "title": "Users",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Users endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for users POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the users endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

[
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "User is not found",
        "statusCode": "INVALID_USER_ID"
      }
    ]
  }
]

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 204

User deleted.

HTTP status code 403

The user credentials or the account are not permitted to use this endpoint.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/users_4xx.json",
  "title": "Users",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Users endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for users POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the users endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

{
  "status": "FAILURE",
  "errors": [
    {
      "message": "No permission to perform operations for the account provided",
      "statusCode": "INVALID_ACCOUNTNAME"
    }
  ]
}

HTTP status code 404

User not found.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/users_4xx.json",
  "title": "Users",
  "type": "object",
  "item": {
    "title": "Users",
    "type": "object",
    "properties": {
      "status": {
        "description": "Users endpoint request response when it has failed.",
        "type": "string",
        "maxLength": 10
      },
      "errors": {
        "description": "List of errors for users POST/PUT/GET/DELETE",
        "type": "array",
        "items": {
          "description": "Error object containing information on why the users endpoint failed",
          "type": "object",
          "properties": {
            "message": {
              "description": "Human readable error message",
              "type": "string",
              "maxLength": 200
            },
            "statusCode": {
              "description": "Error code.",
              "type": "string",
              "maxLength": 100
            }
          }
        },
        "minItems": 1
      }
    },
    "required": [
      "status",
      "errors"
    ]
  }
}

Example:

[
  {
    "status": "FAILURE",
    "errors": [
      {
        "message": "User is not found",
        "statusCode": "INVALID_USER_ID"
      }
    ]
  }
]

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

reset password email is sent if emailAddress provided is valid

HTTP status code 400

email adress is not valid, no email will be sent

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/usergroup.json",
  "title": "UserGroup",
  "type": "object",
  "items": {
    "title": "UserGroup",
    "type": "object",
    "properties": {
      "userGroupId": {
        "description": "UID of the user security group",
        "type": "integer"
      },
      "name": {
        "description": "Name of the user security group",
        "type": "string",
        "maxLength": 200
      },
      "decription": {
        "description": "Description of the user security group",
        "type": "string",
        "maxLength": 200
      },
      "links": {
        "description": "Reference link for current resource",
        "type": "object",
        "properties": {
          "rel": {
            "description": "The object that the link is related to.",
            "type": "string"
          },
          "href": {
            "description": "Reference link for current object.",
            "type": "string"
          }
        }
      }
    }
  }
}

Example:

[
  {
    "userGroupId": 39,
    "name": "Test Api Users",
    "description": "Test Api Users Group",
    "links": [
      {
        "rel": "self",
        "href": "https://us-east-1-api.lift.acquia.com/api/v1/accounts/Test/usergroups/39"
      }
    ]
  }
]

HTTP status code 404

User security group is not found.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

The visitor profile was able to be retrieved.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/visitor_query_response.json",
  "type": "object",
  "title": "Visitor Query",
  "description": "Visitor Query Response.",
  "properties": {
    "person": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "Unique person ID — Acquia Lift Profile Manager internal value."
        },
        "engagementScore": {
          "type": "integer",
          "description": "Numeric representation of this person's engagement with the brand that is calculated by customer-specific rules (for example, a visitor with a newsletter subscription is more engaged than a periodic visitor); calculated here as the sum of all engagement scores at the event level over a 90-day period."
        },
        "lastTouch": {
          "type": "string",
          "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9]Z$",
          "description": "Time and date of the person's last touch."
        },
        "firstTouch": {
          "type": "string",
          "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9]Z$",
          "description": "Time and date of the person's first touch."
        },
        "firstTimeVisitor": {
          "type": "boolean",
          "description": "Indicates whether a person is a first-time visitor. This criteria will match for the duration of the very first touch of a new person."
        },
        "subscriberStatus": {
          "type": "string",
          "description": "The person's subscription status — optional and provided externally."
        },
        "customerId": {
          "type": "integer",
          "description": "Internal Acquia Lift Profile Manager customer ID."
        },
        "primaryIdentifier": {
          "type": "string",
          "description": "Tracking ID assigned to a website visitor and stored in their cookies; if there are multiple identifiers, this field reflects the first assigned identifier."
        },
        "primaryIdentifierTypeId": {
          "type": "integer",
          "description": "Person's identifier type — this will always have a value of 2 to reflect the first tracking ID assigned by Acquia Lift Profile Manager."
        },
        "active": {
          "type": "boolean",
          "description": "The person is a unique entity; false indicates this person was merged into another person during identity resolution (touches and events remain linked to the original person)."
        },
        "lastModifiedDate": {
          "type": "string",
          "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9]Z$",
          "description": "Time and date that the row was last modified."
        },
        "anonymousVisitor": {
          "type": "boolean",
          "description": "Person without any identity information, such as an email address or account ID."
        },
        "doNotTrack": {
          "type": "boolean",
          "description": "Indicates whether or not the person has opted out of tracking and personalization."
        },
        "^(person)_udf([1-9]|[1-4][0-9]|50)$": {
          "type": "string",
          "maxLength": 1000,
          "description": "Custom fields for person."
        }
      }
    },
    "identifiers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Unique person identifier ID — Acquia Lift Profile Manager internal value."
          },
          "identifier": {
            "type": "string",
            "description": "Person's identifier information, based on the person_identifier_type_id."
          },
          "personIdentifierTypeId": {
            "type": "integer",
            "description": "Person's identifier type (options: 1 - email, 2 - tracking identifier, 3 - account id, 4 - Facebook account, 5 - Twitter account, 6 - name, 100 - amp)."
          },
          "personIdentifierTypeName": {
            "type": "string",
            "description": "Person's identifier type name (options: email, tracking, account, facebook, twitter, name, amp, etc.)"
          },
          "personIdentifierTypeName": {
            "type": "string",
            "description": "Person's identifier type name (options: email, tracking, account, facebook, twitter, name, etc)"
          },
          "personId": {
            "type": "integer",
            "description": "Unique person ID — Acquia Lift Profile Manager internal value."
          },
          "customerId": {
            "type": "integer",
            "description": "Internal Acquia Lift Profile Manager customer ID."
          },
          "active": {
            "type": "boolean",
            "description": "The person is a unique entity; false indicates this person was merged into another person during identity resolution (touches and events remain linked to the original person)."
          }
        }
      }
    },
    "touches": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Unique touch ID — Profile Manager internal value."
          },
          "touchDuration": {
            "type": "integer",
            "description": "Touch duration in minutes."
          },
          "touchDurationInSeconds": {
            "type": "integer",
            "description": "Touch duration in seconds."
          },
          "touchDate": {
            "type": "string",
            "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9]Z$",
            "description": "Touch start-date/time."
          },
          "channelType": {
            "type": "string",
            "description": "Source for this touch (for example, Web or Call Center)."
          },
          "engagementScore": {
            "type": "integer",
            "description": "Numeric representation (calculated by customer-specific rules) of how this touch describes a person's engagement with the brand."
          },
          "referrer": {
            "type": "string",
            "description": "Referrer URL."
          },
          "url": {
            "type": "string",
            "description": "URL."
          },
          "referrerDomain": {
            "type": "string",
            "description": "Referrer base domain."
          },
          "numberOfPageViews": {
            "type": "integer",
            "description": "Number of page views."
          },
          "identifier": {
            "type": "string",
            "description": "Touch session identifier."
          },
          "visitorIp": {
            "type": "string",
            "maxLength": 45,
            "description": "Visitor's IP address (supports both IPv4 and IPv6 addresses)."
          },
          "userAgentString": {
            "type": "string",
            "maxLength": 2000,
            "description": "Visitor's user agent."
          },
          "operatingSystem": {
            "type": "string",
            "description": "Operating system of the visitor's machine."
          },
          "platform": {
            "type": "string",
            "description": "Platform type of the visitor's machine."
          },
          "browser": {
            "type": "string",
            "description": "Browser used by the visitor."
          },
          "lastModifiedDate": {
            "type": "string",
            "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9]Z$",
            "description": "Time and date that the row was last modified."
          },
          "personId": {
            "type": "integer",
            "description": "Points to the associated person's person_id for this touch."
          },
          "customerId": {
            "type": "integer",
            "description": "Internal Acquia Lift Profile Manager customer ID assignment."
          },
          "personIdentifierId": {
            "type": "integer",
            "description": "Internal Profile Manager ID for the person_identifier that was triggered by this touch."
          },
          "customerSiteId": {
            "type": "string",
            "maxLength": 20,
            "description": "The internal customer site ID matching external_site_id in the configuration database."
          },
          "^(touch)_udf([1-9]|1[0-9]|20)$": {
            "type": "string",
            "maxLength": 1000,
            "description": "Custom fields for touch."
          },
          "events": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "integer",
                  "description": "Unique event ID - Acquia Lift Profile Manager internal value."
                },
                "name": {
                  "type": "string",
                  "description": "Name of the event (for example, Content View)."
                },
                "engagementScore": {
                  "type": "integer",
                  "description": "Numeric representation (calculated by customer-specific rules) of how this event describes a person's engagement with the brand."
                },
                "eventDate": {
                  "type": "string",
                  "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9]Z$",
                  "description": "Event date-time."
                },
                "eventCategoryType": {
                  "type": "string",
                  "description": "Event's category type."
                },
                "accountId": {
                  "type": "string",
                  "description": "Customer account Id."
                },
                "referrer": {
                  "type": "string",
                  "description": "Referrer URL."
                },
                "pageType": {
                  "type": "string",
                  "maxLength": 200,
                  "description": "Category of page the visitor viewed (examples include article page, tag page, and home page)."
                },
                "pageUrl": {
                  "type": "string",
                  "description": "Page URL."
                },
                "captureIdentifier": {
                  "type": "string",
                  "description": "Event identifier."
                },
                "contentType": {
                  "type": "string",
                  "maxLength": 200,
                  "description": "Content type to which a piece of visitor-viewed content belongs."
                },
                "contentSection": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Content section of an article."
                },
                "contentTitle": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Content title of an article/page."
                },
                "keywords": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Content keywords of an article."
                },
                "contentId": {
                  "type": "string",
                  "maxLength": 22,
                  "description": "Content id of an article."
                },
                "touchId": {
                  "type": "integer",
                  "description": "Link to an existing id for a touch — Acquia Lift Profile Manager internal value."
                },
                "personId": {
                  "type": "integer",
                  "description": "Link to an existing id for a person — Acquia Lift Profile Manager internal value."
                },
                "customerId": {
                  "type": "integer",
                  "description": "Internal Acquia Lift Profile Manager customer ID."
                },
                "eventCategoryId": {
                  "type": "integer",
                  "description": "Code for the event (refer to the name field for its human-readable name) — Acquia Lift Profile Manager internal value."
                },
                "customerSiteId": {
                  "type": "string",
                  "maxLength": 20,
                  "description": "The internal customer site ID matching external_site_id in the configuration database."
                },
                "clientDate": {
                  "type": "string",
                  "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9]Z$",
                  "description": "Browser's date and time when the event was made."
                },
                "clientTimezone": {
                  "type": "string",
                  "description": "Browser's timezone when the event was made."
                },
                "customerSiteExternalId": {
                  "type": "string",
                  "maxLength": 20,
                  "description": "The external customer site ID matching external_site_id in the configuration database."
                },
                "lastModifiedDate": {
                  "type": "string",
                  "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T(0[0-9]|1[0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9]Z$",
                  "description": "Time and date that the row was last modified."
                },
                "personalizationName": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Name of personalization associated with an event."
                },
                "personalizationMachineName": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Machine name of personalization associated with an event."
                },
                "personalizationChosenVariation": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "The variation (decision) chosen for an event."
                },
                "personalizationAudienceName": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "The name of the audience."
                },
                "personalizationDecisionPolicy": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "The decision policy used - for example, explore or target."
                },
                "personalizationGoalName": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "The name of the goal reached."
                },
                "personalizationGoalValue": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "The value of the goal reached."
                },
                "decisionSlotId": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Decision Slot Id"
                },
                "decisionSlotName": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Decision Slot Name"
                },
                "decisionRuleId": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Decision Rule Id"
                },
                "decisionRuleName": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Decision Rule Name"
                },
                "decisionRuleSegmentId": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Decision Rule Segment Id"
                },
                "decisionRuleSegmentName": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Decision Rule Segment Name"
                },
                "decisionRuleType": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Decision Rule Type"
                },
                "decisionContentId": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Decision Content Id"
                },
                "decisionContentName": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Decision Content Name"
                },
                "decisionGoalId": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Decision Goal Id"
                },
                "decisionGoalName": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Decision Goal Name"
                },
                "decisionGoalValue": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Decision Goal Value"
                },
                "decisionViewMode": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Decision View Mode"
                },
                "decisionPolicy": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Decision Policy"
                },
                "decision_campaign_id": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Unique ID of the rule's campaign"
                },
                "decision_campaign_name": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Descriptive name of the rule's campaign"
                },
                "decision_rule_ab_variation": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Name of the AB test rule's chosen variation"
                },
                "^(event)_udf([1-9]|[1-4][0-9]|50)$": {
                  "type": "string",
                  "maxLength": 1000,
                  "description": "Custom fields for event."
                }
              }
            }
          }
        }
      }
    }
  }
}

Example:

{
  "person": {
    "id": 1946437,
    "engagementScore": 1,
    "lastTouch": "2018-05-02T21:21:36Z",
    "firstTouch": "2018-05-02T21:21:36Z",
    "firstTimeVisitor": true,
    "subscriberStatus": "Unknown",
    "customField1": "testContentSection",
    "customField2": "testContentType",
    "customField3": "testContentKeywords",
    "customField4": "personUDF4",
    "customField5": "personUDF5",
    "customField6": "personUDF6",
    "customField7": "personUDF7",
    "customField8": "personUDF8",
    "customField9": "personUDF9",
    "customField10": "personUDF10",
    "customField11": "personUDF11",
    "customField12": "personUDF12",
    "customField13": "personUDF13",
    "customField14": "personUDF14",
    "customField15": "personUDF15",
    "customField16": "personUDF16",
    "customField17": "personUDF17",
    "customField18": "personUDF18",
    "customField19": "personUDF19",
    "customField20": "personUDF20",
    "customField21": "personUDF21",
    "customField22": "personUDF22",
    "customField23": "personUDF23",
    "customField24": "personUDF24",
    "customField25": "personUDF25",
    "customField26": "personUDF26",
    "customField27": "personUDF27",
    "customField28": "personUDF28",
    "customField29": "personUDF29",
    "customField30": "personUDF30",
    "customField31": "personUDF31",
    "customField32": "personUDF32",
    "customField33": "personUDF33",
    "customField34": "personUDF34",
    "customField35": "personUDF35",
    "customField36": "personUDF36",
    "customField37": "personUDF37",
    "customField38": "personUDF38",
    "customField39": "personUDF39",
    "customField40": "personUDF40",
    "customField41": "personUDF41",
    "customField42": "personUDF42",
    "customField43": "personUDF43",
    "customField44": "personUDF44",
    "customField45": "personUDF45",
    "customField46": "personUDF46",
    "customField47": "personUDF47",
    "customField48": "personUDF48",
    "customField49": "personUDF49",
    "customField50": "personUDF50",
    "customerId": 12345,
    "primaryIdentifier": "tkeLec0tfe9w9dvpw0wiFk",
    "primaryIdentifierTypeId": 2,
    "active": true,
    "lastModifiedDate": "2018-05-02T21:21:43Z",
    "anonymousVisitor": false,
    "doNotTrack": false
  },
  "identifiers": [
    {
      "id": 3762181,
      "identifier": "tkeLec0tfe9w9dvpw0wiFk",
      "personIdentifierTypeId": 2,
      "personIdentifierTypeName": "tracking",
      "personId": 1946437,
      "customerId": 12345,
      "active": true
    },
    {
      "id": 3762182,
      "identifier": "sample@acquia.com",
      "personIdentifierTypeId": 1,
      "personIdentifierTypeName": "email",
      "personId": 1946437,
      "customerId": 12345,
      "active": true
    },
    {
      "id": 3762185,
      "identifier": "testACCOUNT_sample",
      "personIdentifierTypeId": 3,
      "personIdentifierTypeName": "account",
      "personId": 1946437,
      "customerId": 12345,
      "active": true
    },
    {
      "id": 3762187,
      "identifier": "testAMP_sample",
      "personIdentifierTypeId": 100,
      "personIdentifierTypeName": "amp",
      "personId": 1946437,
      "customerId": 12345,
      "active": true
    },
    {
      "id": 3762183,
      "identifier": "testNAME_sample",
      "personIdentifierTypeId": 6,
      "personIdentifierTypeName": "name",
      "personId": 1946437,
      "customerId": 12345,
      "active": true
    },
    {
      "id": 3762186,
      "identifier": "testFACEBOOK_sample",
      "personIdentifierTypeId": 4,
      "personIdentifierTypeName": "facebook",
      "personId": 1946437,
      "customerId": 12345,
      "active": true
    },
    {
      "id": 3762184,
      "identifier": "testTWITTER_sample",
      "personIdentifierTypeId": 5,
      "personIdentifierTypeName": "twitter",
      "personId": 1946437,
      "customerId": 12345,
      "active": true
    }
  ],
  "touches": [
    {
      "id": 1234567,
      "touchDuration": 0,
      "touchDurationInSeconds": 0,
      "touchDate": "2018-05-02T21:21:36Z",
      "channelType": "Web",
      "engagementScore": 1,
      "referrer": "www.drupal.org",
      "url": "www.acquia.com",
      "numberOfPageViews": 0,
      "identifier": "4f5baf25da524ek689390",
      "customField1": "touchUDF1",
      "customField2": "touchUDF2",
      "customField3": "touchUDF3",
      "customField4": "touchUDF4",
      "customField5": "touchUDF5",
      "customField6": "touchUDF6",
      "customField7": "touchUDF7",
      "customField8": "touchUDF8",
      "customField9": "touchUDF9",
      "customField10": "touchUDF10",
      "customField11": "touchUDF11",
      "customField12": "touchUDF12",
      "customField13": "touchUDF13",
      "customField14": "touchUDF14",
      "customField15": "touchUDF15",
      "customField16": "touchUDF16",
      "customField17": "touchUDF17",
      "customField18": "touchUDF18",
      "customField19": "touchUDF19",
      "customField20": "touchUDF20",
      "visitorIp": "192.168.1.1",
      "userAgentString": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10.10; rv:41.0) Gecko\/20100101 Firefox\/41.0",
      "operatingSystem": "Mac OS X",
      "platform": "DESKTOP",
      "browser": "FIREFOX",
      "lastModifiedDate": "2018-05-02T21:21:43Z",
      "personId": 1946437,
      "customerId": 12345,
      "personIdentifierId": 3762181,
      "customerSiteId": 3494,
      "events": [
        {
          "id": 3884539,
          "name": "Goal",
          "engagementScore": 1,
          "eventDate": "2018-05-02T21:21:36Z",
          "eventCategoryType": "OTHER",
          "accountId": "SAMPLECUSTOMER",
          "referrer": "www.drupal.org",
          "pageType": "testPageType",
          "pageUrl": "www.acquia.com",
          "captureIdentifier": "5ba827b282454c2baeac7",
          "contentType": "testContentType",
          "contentSection": "testContentSection",
          "contentTitle": "testContentTitle",
          "keywords": "testContentKeywords",
          "contentId": "67b5fe10c71e4f3cba8e2",
          "touchId": 1234567,
          "personId": 1946437,
          "customerId": 12345,
          "eventCategoryId": 10068,
          "customerSiteId": 3494,
          "clientDate": "2018-05-02T17:21:23Z",
          "clientTimezone": "America\/Anguilla",
          "customerSiteExternalId": "SITE1",
          "lastModifiedDate": "2018-05-02T21:21:43Z",
          "customField1": "eventUDF1",
          "customField3": "eventUDF3",
          "customField4": "eventUDF4",
          "customField5": "eventUDF5",
          "customField6": "eventUDF6",
          "customField7": "eventUDF7",
          "customField8": "eventUDF8",
          "customField9": "eventUDF9",
          "customField10": "eventUDF10",
          "customField11": "eventUDF11",
          "customField12": "eventUDF12",
          "customField13": "eventUDF13",
          "customField14": "eventUDF14",
          "customField15": "eventUDF15",
          "customField16": "eventUDF16",
          "customField17": "eventUDF17",
          "customField18": "eventUDF18",
          "customField19": "eventUDF19",
          "customField20": "eventUDF20",
          "customField21": "eventUDF21",
          "customField22": "eventUDF22",
          "customField23": "eventUDF23",
          "customField24": "eventUDF24",
          "customField25": "eventUDF25",
          "customField26": "eventUDF26",
          "customField27": "eventUDF27",
          "customField28": "eventUDF28",
          "customField29": "eventUDF29",
          "customField30": "eventUDF30",
          "customField31": "eventUDF31",
          "customField32": "eventUDF32",
          "customField33": "eventUDF33",
          "customField34": "eventUDF34",
          "customField35": "eventUDF35",
          "customField36": "eventUDF36",
          "customField37": "eventUDF37",
          "customField38": "eventUDF38",
          "customField39": "eventUDF39",
          "customField40": "eventUDF40",
          "customField41": "eventUDF41",
          "customField42": "eventUDF42",
          "customField43": "eventUDF43",
          "customField44": "eventUDF44",
          "customField45": "eventUDF45",
          "customField46": "eventUDF46",
          "customField47": "eventUDF47",
          "customField48": "eventUDF48",
          "customField49": "eventUDF49",
          "customField50": "eventUDF50",
          "personalizationName": "testPersonalizationName",
          "personalizationMachineName": "testPersonalizationMachineName",
          "personalizationChosenVariation": "testPersonalizationChosenVariation",
          "personalizationAudienceName": "testPersonalizationAudienceName",
          "personalizationDecisionPolicy": "testPersonalizationDecisionPolicy",
          "personalizationGoalName": "testPersonalizationGoalName",
          "personalizationGoalValue": "10",
          "decisionSlotId": "testDecisionSlotId",
          "decisionSlotName": "testDecisionSlotName",
          "decisionRuleId": "testDecisionRuleId",
          "decisionRuleName": "testDecisionRuleName",
          "decisionContentId": "testDecisionContentId",
          "decisionContentName": "testDecisionContentName",
          "decisionGoalId": "testDecisionGoalId",
          "decisionGoalName": "testDecisionGoalName",
          "decisionGoalValue": "testDecisionGoalValue",
          "decisionViewMode": "testDecisionViewMode",
          "decisionPolicy": "testDecisionPolicy",
          "decisionRuleAbVariation": "testDecisionRuleAbVariation",
          "decisionCampaignId": "testDecisionCampaignId",
          "decisionCampaignName": "testDecisionCampaignName"
        }
      ]
    }
  ]
}

HTTP status code 400

The identifierType is an invalid value for the customer account, and/or the personTables parameter value is invalid.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/visitor_query_400.json",
  "type": "object",
  "title": "Visitor Query",
  "description": "Visitor Query 400 Response.",
  "properties": {
    "status": {
      "description": "Visitor Query endpoint request response when it has failed.",
      "type": "string"
    },
    "errors": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "statusCode": {
              "type": "string"
            },
            "message": {
              "type": "string"
            }
          },
          "required": [
            "statusCode",
            "message"
          ]
        }
      ]
    }
  },
  "required": [
    "status",
    "errors"
  ]
}

Example:

####### Example 1 - Identifier type parameter is missing ###########
{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "error",
      "message": "Error: Missing identifier type parameter."
    }
  ]
}

####### Example 2 - Identifier parameter is missing ###########
{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "error",
      "message": "Error: Missing identifier parameter."
    }
  ]
}

####### Example 3 - Person tables parameter is missing ###########
{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "error",
      "message": "Error: Missing person tables parameter."
    }
  ]
}

####### Example 4 - Invalid Person tables ###########
{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "error",
      "message": "Error: Invalid person tables."
    }
  ]
}

####### Example 5 - Invalid person identifier type ###########
{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "error",
      "message": "Error: Invalid person identifier type"
    }
  ]
}

HTTP status code 404

The visitor profile could not be found.

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/visitor_query_404.json",
  "type": "object",
  "title": "Visitor Query",
  "description": "Visitor Query 404 Response.",
  "properties": {
    "status": {
      "description": "Visitor Query endpoint request response when it has failed.",
      "type": "string"
    },
    "errors": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "statusCode": {
              "type": "string"
            },
            "message": {
              "type": "string"
            }
          },
          "required": [
            "statusCode",
            "message"
          ]
        }
      ]
    }
  },
  "required": [
    "status",
    "errors"
  ]
}

Example:

{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "error",
      "message": "Error: No person was found with identifier 'test@example.com' and identifier type 'email'."
    }
  ]
}

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

The reset password request email was successfully sent.

HTTP status code 400

The reset password request was invalid. Either the email, or the request model failed to validate.

HTTP status code 500

The reset password request could not be completed by the server due to an internal error.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/column_metadata_v2_getall_response.json",
  "title": "Get All Column Metadata",
  "type": "object",
  "items": {
    "title": "Column Metadata",
    "type": "object",
    "required": [
      "total",
      "data"
    ],
    "properties": {
      "total": {
        "type": "integer",
        "description": "Total number of column metadata for the customer"
      },
      "data": {
        "type": "array",
        "description": "Array of returned Column metadata",
        "required": [
          "id",
          "displayName",
          "tableName",
          "accessor",
          "columnType",
          "description",
          "fieldName"
        ],
        "items": {
          "type": "object",
          "properties": {
            "id": {
              "description": "Column metadata Id.",
              "type": "string",
              "maxLength": 100
            },
            "displayName": {
              "description": "Human readable name of the column metadata.",
              "type": "string",
              "maxLength": 100
            },
            "tableName": {
              "description": "Table name for which this column metadata belongs to.",
              "type": "string",
              "maxLength": 100
            },
            "accessor": {
              "description": "Accessor name for column metadata",
              "type": "string",
              "maxLength": 3000
            },
            "columnType": {
              "description": "Column type",
              "type": "string",
              "maxLength": 100,
              "enum": [
                "STRING",
                "BOOLEAN",
                "DATE",
                "INTEGER",
                "FLOAT",
                "COMMA_SEPARATED_LIST"
              ]
            },
            "description": {
              "description": "Human readable description of the column metadata.",
              "type": "string",
              "maxLength": 3000
            },
            "fieldName": {
              "description": "Field name for column metadata",
              "type": "string",
              "maxLength": 3000
            }
          }
        }
      }
    }
  }
}

Example:

{
  "data": [
    {
      "id": "11547",
      "displayName": "testsha1",
      "tableName": "PERSON",
      "accessor": "getAnonymousVisitor",
      "columnType": "BOOLEAN",
      "description": "dsadasdad",
      "fieldName": "ANONYMOUS_VISITOR"
    },
    {
      "id": "11548",
      "displayName": "test123",
      "tableName": "PERSON",
      "accessor": "getArticlesRemaining",
      "columnType": "BOOLEAN",
      "description": "hjhjhjhj",
      "fieldName": "ARTICLES_REMAINING"
    },
    {
      "id": "11549",
      "displayName": "gjgjgj",
      "tableName": "PERSON",
      "accessor": "getCustomField1",
      "columnType": "BOOLEAN",
      "description": "hjhjkhkj",
      "fieldName": "CUSTOM_FIELD_1"
    },
    {
      "id": "11550",
      "displayName": "khhkhk",
      "tableName": "PERSON",
      "accessor": "getCustomField2",
      "columnType": "BOOLEAN",
      "description": "hjkh",
      "fieldName": "CUSTOM_FIELD_2"
    },
    {
      "id": "11551",
      "displayName": "kllhvv",
      "tableName": "PERSON",
      "accessor": "getCustomField3",
      "columnType": "BOOLEAN",
      "description": "jhhjk",
      "fieldName": "CUSTOM_FIELD_3"
    },
    {
      "id": "11552",
      "displayName": "bbmmbb",
      "tableName": "PERSON",
      "accessor": "getCustomField4",
      "columnType": "BOOLEAN",
      "description": "hhkhk",
      "fieldName": "CUSTOM_FIELD_4"
    },
    {
      "id": "11553",
      "displayName": "hhjkh",
      "tableName": "PERSON",
      "accessor": "getCustomField5",
      "columnType": "BOOLEAN",
      "description": "hhhjk",
      "fieldName": "CUSTOM_FIELD_5"
    },
    {
      "id": "11554",
      "displayName": "hhjhkjkj",
      "tableName": "PERSON",
      "accessor": "getCustomField6",
      "columnType": "BOOLEAN",
      "description": "khhk",
      "fieldName": "CUSTOM_FIELD_6"
    },
    {
      "id": "11555",
      "displayName": "jgjhhgg",
      "tableName": "PERSON",
      "accessor": "getCustomField7",
      "columnType": "BOOLEAN",
      "description": "khhhk",
      "fieldName": "CUSTOM_FIELD_7"
    },
    {
      "id": "11556",
      "displayName": "hkhhkhk",
      "tableName": "PERSON",
      "accessor": "getCustomField8",
      "columnType": "BOOLEAN",
      "description": "hhhjkhjk",
      "fieldName": "CUSTOM_FIELD_8"
    },
    {
      "id": "11557",
      "displayName": "kkkllkk;ll;",
      "tableName": "PERSON",
      "accessor": "getCustomField9",
      "columnType": "BOOLEAN",
      "description": "lll",
      "fieldName": "CUSTOM_FIELD_9"
    }
  ],
  "total": 11
}

HTTP status code 400

If request payload is invalid (missing parameter / invalid parameters).

Body

Media type: application/json

Type: any

Example:

{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "INVALID_START_ID",
      "message": "start value should be in between 0 to 10000"
    }
  ]
}

HTTP status code 401

Unauthorized access to endpoint

HTTP status code 403

No permission to perform operations for the account provided

Body

Media type: application/json

Type: any

Example:

{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "INVALID_ACCOUNTNAME",
      "message": "No permission to perform operations for the account provided"
    }
  ]
}

HTTP status code 500

An internal server error occurred while getting all column metadata from API

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.

HTTP status code 200

Get Column metadata by ID was successful

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "schemas/column_metadata_v2_get_response.json",
  "title": "Get Column Metadata",
  "type": "object",
  "properties": {
            "id": {
              "description": "Column metadata Id.",
              "type": "string",
              "maxLength": 100
            },
            "displayName": {
              "description": "Human readable name of the column metadata.",
              "type": "string",
              "maxLength": 100
            },
            "tableName": {
              "description": "Table name for which this column metadata belongs to.",
              "type": "string",
              "maxLength": 100
            },
            "accessor": {
              "description": "Accessor name for column metadata",
              "type": "string",
              "maxLength": 3000
            },
            "columnType": {
              "description": "Column type",
              "type": "string",
              "maxLength": 100,
              "enum": [
                "STRING",
                "BOOLEAN",
                "DATE",
                "INTEGER",
                "FLOAT",
                "COMMA_SEPARATED_LIST"
              ]
            },
            "description": {
              "description": "Human readable description of the column metadata.",
              "type": "string",
              "maxLength": 3000
            },
            "fieldName": {
              "description": "Field name for column metadata",
              "type": "string",
              "maxLength": 3000
            }
          },
  "required": [
    "id",
    "displayName",
    "tableName",
    "accessor",
    "columnType",
    "description",
    "fieldName"
  ]
}

Example:

{
  "id": "11554",
  "displayName": "hhjhkjkj",
  "tableName": "PERSON",
  "accessor": "getCustomField6",
  "columnType": "BOOLEAN",
  "description": "khhk",
  "fieldName": "CUSTOM_FIELD_6"
}

HTTP status code 401

Unauthorized access to endpoint

HTTP status code 403

No permission to perform operations for the account provided

Body

Media type: application/json

Type: any

Example:

{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "INVALID_ACCOUNTNAME",
      "message": "No permission to perform operations for the account provided"
    }
  ]
}

HTTP status code 404

Invalid column metadata ID was supplied.

Body

Media type: application/json

Type: any

Example:

{
  "status": "FAILED",
  "errors": [
    {
      "statusCode": "INVALID_COLUMN_METADATA_ID",
      "message": "Customer column metadata does not exist for id 115549"
    }
  ]
}

HTTP status code 500

An internal server error occurred when getiting column metatadata from API.

Secured by AcquiaHMACv2

Headers

• Authorization: required(string)

  Additional HTTP headers:
  Authorization: <HMACAuthorization>
  X-Authorization-Timestamp: <Unix Timestamp In Seconds>
  X-Authorization-Content-SHA256: <HashedContent> (if Content-Length > 0)
  

HTTP status code 200

Request succeeded successfully

HTTP status code 201

Request entity was created successfully

HTTP status code 202

Request was accepted.

HTTP status code 204

Request entity was deleted successfully.

HTTP status code 400

Request entity contains missing or invalid values for the parameters.

HTTP status code 401

Bad or expired token. This can happen if the user revoked or expired an access token. To fix, you should re-authenticate the user.

HTTP status code 403

Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here. The user may also not be allowed to use a particular API endpoint.

HTTP status code 404

Request entity cannot be found.