Skip to content

Add get_subscriber_stats method #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
n7studios merged 3 commits into from
Oct 3, 2025
Merged

Add get_subscriber_stats method #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
522723b
Add `get_subscriber_stats` method
n7studios Sep 30, 2025
0e4f71d
Merge remote-tracking branch 'origin/fix-tests' into add-subscriber-s…
n7studios Oct 3, 2025
ad4c6a5
Reinstate tests
n7studios Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/ConvertKit_API_Traits.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1044,6 +1044,20 @@ public function unsubscribe(int $subscriber_id)
return $this->post(sprintf('subscribers/%s/unsubscribe', $subscriber_id));
}

/**
* Get the email statistics for a specific subscriber.
*
* @param integer $id Subscriber ID.
*
* @see https://developers.kit.com/api-reference/subscribers/list-stats-for-a-subscriber
*
* @return mixed|object
*/
public function get_subscriber_stats(int $id)
{
return $this->get(sprintf('subscribers/%s/stats', $id));
}

/**
* Get a list of the tags for a subscriber.
*
Expand Down
43 changes: 43 additions & 0 deletions tests/ConvertKitAPITest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1775,6 +1775,49 @@ public function testUpdateTagNameWithBlankName()
);
}

/**
* Test that get_subscriber_stats() returns the expected data
* when using a valid subscriber ID.
*
* @since 2.2.1
*
* @return void
*/
public function testGetSubscriberStats()
{
$result = $this->api->get_subscriber_stats(
id: (int) $_ENV['CONVERTKIT_API_SUBSCRIBER_ID']
);
$this->assertArrayHasKey('subscriber', get_object_vars($result));
$this->assertArrayHasKey('id', get_object_vars($result->subscriber));
$this->assertArrayHasKey('stats', get_object_vars($result->subscriber));
$this->assertArrayHasKey('sent', get_object_vars($result->subscriber->stats));
$this->assertArrayHasKey('opened', get_object_vars($result->subscriber->stats));
$this->assertArrayHasKey('clicked', get_object_vars($result->subscriber->stats));
$this->assertArrayHasKey('bounced', get_object_vars($result->subscriber->stats));
$this->assertArrayHasKey('open_rate', get_object_vars($result->subscriber->stats));
$this->assertArrayHasKey('click_rate', get_object_vars($result->subscriber->stats));
$this->assertArrayHasKey('last_sent', get_object_vars($result->subscriber->stats));
$this->assertArrayHasKey('last_opened', get_object_vars($result->subscriber->stats));
$this->assertArrayHasKey('last_clicked', get_object_vars($result->subscriber->stats));
$this->assertArrayHasKey('sends_since_last_open', get_object_vars($result->subscriber->stats));
$this->assertArrayHasKey('sends_since_last_click', get_object_vars($result->subscriber->stats));
}

/**
* Test that get_subscriber_stats() throws a ClientException when an invalid
* subscriber ID is specified.
*
* @since 2.2.1
*
* @return void
*/
public function testGetSubscriberStatsWithInvalidSubscriberID()
{
$this->expectException(ClientException::class);
$result = $this->api->get_subscriber_stats(12345);
}

/**
* Test that tag_subscriber_by_email() returns the expected data.
*
Expand Down