Skip to main content
GET
/
partners
/
analytics
PHP
declare(strict_types=1);

require 'vendor/autoload.php';

use Dub;
use Dub\Models\Operations;

$sdk = Dub\Dub::builder()
    ->setSecurity(
        'DUB_API_KEY'
    )
    ->build();

$request = new Operations\RetrievePartnerAnalyticsRequest(
    timezone: 'America/New_York',
    query: 'metadata[\'key\']:\'value\'',
);

$response = $sdk->partners->analytics(
    request: $request
);

if ($response->oneOf !== null) {
    // handle response
}
{
  "clicks": 0,
  "leads": 0,
  "sales": 0,
  "saleAmount": 0,
  "earnings": 0
}
Partners endpoints require an Advanced plan subscription or higher.

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Query Parameters

​
partnerId
string | null

The ID of the partner to create a link for. Will take precedence over tenantId if provided.

​
tenantId
string | null

The ID of the partner in your system. If both partnerId and tenantId are not provided, an error will be thrown.

​
interval
enum<string>

The interval to retrieve analytics for. If undefined, defaults to 24h.

Available options:
24h,
7d,
30d,
90d,
1y,
mtd,
qtd,
ytd,
all
​
start
string

The start date and time when to retrieve analytics from. If set, takes precedence over interval.

​
end
string

The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with start, takes precedence over interval.

​
timezone
string
default:UTC

The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.

Example:

"America/New_York"

​
query
string

Search the events by a custom metadata value. Only available for lead and sale events.

Maximum length: 10000
Example:

"metadata['key']:'value'"

​
groupBy
enum<string>
default:count

The parameter to group the analytics data points by. Defaults to count if undefined.

Available options:
top_links,
timeseries,
count

Response

Partner analytics data

  • PartnerAnalyticsCount · object
  • PartnerAnalyticsTimeseries · object[]
​
clicks
number
default:0
required

The total number of clicks

​
leads
number
default:0
required

The total number of leads

​
sales
number
default:0
required

The total number of sales

​
saleAmount
number
default:0
required

The total amount of sales, in cents

​
earnings
number
default:0
required