OneLink API

URL

https://onelink.appsflyer.com/shortlink/v1/:onelink-id

Method

POST

URL Params

Required:

onelink-id=[alphaNumeric]

Taken from the OneLink configuration screen

Data Params

• brand_domain (optional): You can specify a branded link in the request payload but there are two requirements:
  • The branded links feature is enabled in your account.
  • The branded link is configured in your account.
    Click here to learn how to enable the feature and to configure a branded link.
• TTL (optional): Time to Live for the full attribution link.
• data : JSON format of the query parameters following the AppsFlyer macros for attribution links.

{
 "brand_domain": "click.example.com", #optional, requires a configured branded link
 "ttl" : "25", #optional, default is 31d
 "data" :
   {
   "pid" : "SMS-Offer",
   "c" : "April-Coupon",
   "Custom_param" : "value"
   }
}

Success Response

A successful response contains the shortened OneLink attribution link URL (shortlink), or the branded link with the OneLink and shortlink ID. If you specify a branded link and it is not configured, the response contains a shortlink.

Example:

Code: 200

• Shortlink: https://myapp.onelink.me/abc123/qwer9876
• Branded link: https://click.example.com/abc123/qwer9876

Error Response

Code: 401 UNAUTHORIZED

Content: { error : "Authentication Failed" }

OR

Code: 400 API limit reached

Content: { error : "Data sent exceeds limit" }

Sample Call

curl -X POST \
 https://onelink.appsflyer.com/shortlink/v1/abc123 \
 -H 'authorization: your_token_here'\
 -H 'content-type: application/json' \
 -d '{"brand_domain": "click.example.com"
 "ttl" : "25",
   "data" : {
   "pid": "your PID here",
   "c": "your campaign here"
   }
 }'

Notes

URL

https://onelink.appsflyer.com/shortlink/v1/:onelink-id?id=:shortlink-id

Method

PUT

URL Params

Required:

onelink-id=[alphaNumeric]

Taken from the OneLink configuration screen

shortlink-id=[alphaNumeric]

The id of the short OneLink query params. E.g. For the following OneLink attribution link: myapp.onelink.me/abc123/qwer9876 , the shortlink-id is qwer9876

Data Params

• brand_domain (optional): You can specify a branded link in the request payload but there are two requirements:
  • The branded links feature is enabled in your account.
  • The branded link is configured in your account.
    Click here to learn how to enable the feature and to configure a branded link.
• TTL (optional): Time to Live for the full attribution link. Maximum and default TTL is 31 days. Any TTL value larger than 31 is overridden with 31 . This time frame can be specified in minutes, hours or days (10m/10h/10d) with no distinction defaulting to days.
• data : JSON format of the query parameters following the AppsFlyer macros for attribution links.

Example:

{
 "brand_domain": "click.example.com", #optional, requires a configured branded link
 "ttl" : "25", #optional, default is 31d
 "data" :
   {
   "pid" : "SMS-Offer",
   "c" : "April-Coupon",
   "custom_param" : "value"
   }
}

Success Response

A successful response contains the shortened OneLink attribution link URL (shortlink), or the branded link with the OneLink and shortlink ID. If you specify a branded link and it is not configured, the response contains a shortlink.

Example:

Code: 200

• Shortlink: https://myapp.onelink.me/abc123/qwer9876
• Branded link: https://click.example.com/abc123/qwer9876

Error Response

Code: 401 UNAUTHORIZED

Content: { error : "Authentication Failed" }

OR

Code: 400 Data Error

Content: { error : "Invalid/no data in request" }

OR

Code: 400 API limit reached

Content: { error : "Data sent exceeds limit" }

Sample Call

curl -X PUT\
https://onelink.appsflyer.com/shortlink/v1/abc123?id=qwer9876 \
 -H 'authorization: your_token_here'\
 -H 'content-type: application/json' \
 -d '{"brand_domain": "click.example.com"
   "ttl" : "25",
   "data" : {
   "pid" : "your PID here",
   "c" : "your campaign here"
      }
   }'

URL

https://onelink.appsflyer.com/shortlink/v1/:onelink-id?id=:shortlink-id

Method

GET

URL Params

Required:

onelink-id=[alphaNumeric]

Taken from the OneLink configuration screen

shortlink-id=[alphaNumeric]

The id of the short OneLink query params. E.g. For the following OneLink attribution link: myapp.onelink.me/abc123/qwer9876 , the shortlink-id is qwer9876

Data Params

NONE

Success Response

Successful response contains a JSON of the query params used to define this short link

Example:

Code: 200

Content:

{ "pid": "sms-offer"
"c": "april-coupon"
}

Error Response

Code: 401 UNAUTHORIZED

Content: { error : "Authentication Failed" }

OR

Code: 404 Shortlink record not found

Content: { error : "Record Not Found" }

Sample Call

curl -X GET \
"https://onelink.appsflyer.com/shortlink/v1/abc123?id=qwer9876 \
-H 'authorization: your_token_here'\
-H 'content-type: application/json'

URL

https://onelink.appsflyer.com/shortlink/v1/:onelink-id?id=:shortlink-id

Method

DELETE

URL Params

Required:

onelink-id=[alphaNumeric]

Taken from the OneLink configuration screen

shortlink-id=[alphaNumeric]

The id of the short OneLink query params. E.g. For the following OneLink attribution link: myapp.onelink.me/abc123/qwer9876 , the shortlink-id is qwer9876

Data Params

NONE

Success Response

Example:

Code: 200

Content: ok

Error Response

Code: 401 UNAUTHORIZED

Content: { error : "Authentication Failed" }

OR

Code: 404 Shortlink record not found

Content: { error : "Record Not Found" }

Sample Call

curl -X DELETE \
"onelink.appsflyer.com/shortlink/v1/abc123?id=qwer9876 \
-H 'authorization: your_token_here'\
-H 'content-type: application/json'