Store/Update Revenue

This API request stores and updates revenue data for a specific site using the HTTP method PUT. The request includes the following parameters:

Headers:

AuthorizationstringRequired

The authorization token for accessing the API. The header value should be set to "Bearer {your-access-token}", where {your-access-token} is the access token assigned to the user.

Request Body(JSON payload):

The data containing the ad cost information to store or update. The payload should include the following parameters:

CurrencyCodestringRequired

The appropriate currency code used for the value. This should be in ISO 4217 format. E.g. GBP

ValueintRequired

The value of the revenue.

RevenueClosedDatestringRequired

The date and time the revenue was captured. Must be in one of the ISO 8601 formats and in UTC time standard:

  • yyyy-MM-dd
  • yyyy-MM-ddTHH:mm:ss
  • yyyy-MM-ddTHH:mm:ss.ffffff
LeadDatestring

This can be empty or Must be in one of the ISO 8601 formats and in UTC time standard:

  • yyyy-MM-dd
  • yyyy-MM-ddTHH:mm:ss
  • yyyy-MM-ddTHH:mm:ss.ffffff
VisitorIdentifierOptionsArrayRequired

An array of visitor identifiers. Each item in the array should include the following parameters:

KeystringRequired

The key for the visitor identifier. Accepted Keys: EmailAddress, PhoneNumber, RaId, PayloadValue, CookieValue

ValuestringRequired

The value for the visitor identifier.

If using the CookieValue identifier you must pass the Google Client ID without the GA.1.1 prefix. e.g. GA1.1.101961087.1756204614 should be sent as 101961087.1756204614

LabelsArray(string)Required

Revenue Labels, at least one should be set

ReferencestringRequired

A unique reference for the revenue

AdditionalDataPropertiesArray

An array of additional data properties. Each item in the array should include the following parameters:

NamestringRequired

The name key for the property, this can be set to anything

ValuestringRequired

The value for the named property.


The {your-access-token} parameter in the authorization header should be replaced with the appropriate access token.

Request
PUT
{siteId}/revenue/upload
curl -X PUT \
  'https://rest.rulerapi.com/v1/{siteId}/revenue/upload' \
  -H 'Authorization: Bearer {your-access-token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "CurrencyCode": "{currencyCode}",
    "Value": "{value}",
    "RevenueClosedDate": "{closedDate}",
    "LeadDate": "{leadDate}",
    "VisitorIdentifierOptions": [
      {
       "Key": "{key}",
       "Value": "{value}" 
      }
    ],
    "Labels": [
      "{labels[0]}",
      "{labels[1]}"
    ],
    "Reference": "{reference}",
    "AdditionalDataProperties": [
      {
       "Name": "{name}",
       "Value": "{value}" 
      }
    ]
  }'
Response
Status: 201
API Thresholds
maxRequestsPerSecond: 1000 maxConcurrentRequests: 1000