Add attribution API request

Adds marketing attribution data to a profile.

Endpoint and method

POST https://api.adapty.io/api/v2/web-api/attribution/

Request example

cURL

curl --location 'https://api.adapty.io/api/v2/web-api/attribution/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Api-Key <YOUR_PUBLIC_API_KEY>' \
--data '{
  "status": "organic",
  "attribution_user_id": "attribution_user_id_value",
  "channel": "marketing_channel_value",
  "campaign": "campaign_name_value",
  "ad_group": "ad_group_name_value",
  "ad_set": "ad_set_name_value",
  "creative": "creative_name_value",
  "customer_user_id": "<YOUR_CUSTOMER_USER_ID>"
}
'

JavaScript

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Api-Key <YOUR_PUBLIC_API_KEY>");

const raw = JSON.stringify({
  "status": "organic",
  "attribution_user_id": "attribution_user_id_value",
  "channel": "marketing_channel_value",
  "campaign": "campaign_name_value",
  "ad_group": "ad_group_name_value",
  "ad_set": "ad_set_name_value",
  "creative": "creative_name_value",
  "customer_user_id": "<YOUR_CUSTOMER_USER_ID>"
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow"
};

fetch("https://api.adapty.io/api/v2/web-api/attribution/", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.adapty.io/api/v2/web-api/attribution/")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Api-Key <YOUR_PUBLIC_API_KEY>"
request.body = JSON.dump({
  "status": "organic",
  "attribution_user_id": "attribution_user_id_value",
  "channel": "marketing_channel_value",
  "campaign": "campaign_name_value",
  "ad_group": "ad_group_name_value",
  "ad_set": "ad_set_name_value",
  "creative": "creative_name_value",
  "customer_user_id": "<YOUR_CUSTOMER_USER_ID>"
})

response = https.request(request)
puts response.read_body

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.adapty.io/api/v2/web-api/attribution/',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
  "status": "organic",
  "attribution_user_id": "attribution_user_id_value",
  "channel": "marketing_channel_value",
  "campaign": "campaign_name_value",
  "ad_group": "ad_group_name_value",
  "ad_set": "ad_set_name_value",
  "creative": "creative_name_value",
  "customer_user_id": "<YOUR_CUSTOMER_USER_ID>"
}
',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Api-Key <YOUR_PUBLIC_API_KEY>'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Parameters

Name	Type	Required	Description
status	String	➕	Indicates if the attribution is organic or non-organic. Possible values are: organic non_organic unknown
attribution_user_id	String	➖	ID assigned to the user by the attribution source.
channel	String	➖	Marketing channel name.
campaign	String	➖	Marketing campaign name.
ad_group	String	➖	Attribution ad group.
ad_set	String	➖	Attribution ad set.
creative	String	➖	Attribution creative keyword.
customer_user_id	String	➕*	User ID you use in your app to identify the user if you do. For example, it can be your user UUID, email, or any other ID. Null if you didn't set it. You can find it in the Customer User ID field of the profile in the Adapty Dashboard. * Either customer_user_id or profile_id is required.
profile_id	String	➕*	An identifier of a user in Adapty. You can find it in the Adapty ID field of the profile in the Adapty Dashboard. * Either customer_user_id or profile_id is required.

---

Responses

201: Created

The paywall view is recorded successfully. The response body is blank.

400: Bad Request

The request failed because the value of the status field is invalid. Please check for typos. The possible values are organic, non_organic, and unknown.

Body

Parameter	Type	Description
errors	Object	source: (string) Always status. errors: A description of the error. In this case, value is not a valid enumeration member; permitted: 'organic', 'non_organic', 'unknown'
error_code	String	Short error name. Here: enum.
status_code	Integer	HTTP status. Always 400.

Response example

{
    "errors": [
        {
            "source": "status",
            "errors": [
                "value is not a valid enumeration member; permitted: 'organic', 'non_organic', 'unknown'"
            ]
        }
    ],
    "error_code": "enum",
    "status_code": 400
}

401: Unauthorised

The request failed due to missing or incorrect authorization. Check the Authorization page, paying close attention to the Authorization header.

The request also failed because the specified profile wasn’t found.

Body

Parameter	Type	Description
errors	Object	source: (string) Always non_field_errors. errors: A description of the error.
error_code	String	Short error name. Always not_authenticated.
status_code	Integer	HTTP status. Always 401.

Response example

{
  "errors": [
    {
      "source": "non_field_errors",
      "errors": [
        "Authentication credentials were not provided."
      ]
    }
  ],
  "error_code": "not_authenticated",
  "status_code": 401
}

404: Not Found

The request failed because the specified profile wasn’t found. Double-check the customer_user_id or profile_id for any typos.

Body

Parameter	Type	Description
errors	Object	source: (string) Always null. errors: A description of the error.
error_code	String	Short error name. Always profile_does_not_exist.
status_code	Integer	HTTP status. Always 404.

Response example

{
    "errors": [
        {
            "source": null,
            "errors": [
                "Profile not found"
            ]
        }
    ],
    "error_code": "profile_does_not_exist",
    "status_code": 404
}