PHPackages                             scn/evalanche-reporting-api-connector - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. scn/evalanche-reporting-api-connector

ActiveLibrary[API Development](/categories/api)

scn/evalanche-reporting-api-connector
=====================================

Official PHP client for Evalanche Reporting API

v2.0.0(3y ago)230.5k↓41%3MITPHPPHP ^8.0||^8.1CI passing

Since Oct 18Pushed 3mo ago8 watchersCompare

[ Source](https://github.com/SC-Networks/evalanche-reporting-api-connector)[ Packagist](https://packagist.org/packages/scn/evalanche-reporting-api-connector)[ Docs](https://github.com/SC-Networks/evalanche-reporting-api-connector)[ RSS](/packages/scn-evalanche-reporting-api-connector/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (10)Versions (10)Used By (0)

EVALANCHE REPORTING API CONNECTOR
=================================

[](#evalanche-reporting-api-connector)

[![Monthly Downloads](https://camo.githubusercontent.com/8a92e417df61162ad9793b21b4cd7b4a646d51b6a6aa7f115c3c5113a0808c52/68747470733a2f2f706f7365722e707567782e6f72672f73636e2f6576616c616e6368652d7265706f7274696e672d6170692d636f6e6e6563746f722f642f6d6f6e74686c79)](https://packagist.org/packages/scn/evalanche-reporting-api-connector)[![License](https://camo.githubusercontent.com/5629798d93f62b1fc5de46c440cea52c17795e677724cef988c495710ecb0c75/68747470733a2f2f706f7365722e707567782e6f72672f73636e2f6576616c616e6368652d7265706f7274696e672d6170692d636f6e6e6563746f722f6c6963656e7365)](LICENSE)[![Unittests](https://github.com/SC-Networks/evalanche-reporting-api-connector/actions/workflows/php.yml/badge.svg)](https://github.com/SC-Networks/evalanche-reporting-api-connector/actions/workflows/php.yml)

Install
-------

[](#install)

Via Composer

```
$ composer require scn/evalanche-reporting-api-connector
```

Usage
-----

[](#usage)

### General

[](#general)

First create a connection with the access credentials provided by SC-Networks.

```
use Scn\EvalancheReportingApiConnector\Enum\Language;
use Scn\EvalancheReportingApiConnector\Enum\TimeFormat;
use Scn\EvalancheReportingApiConnector\EvalancheConfig;
use Scn\EvalancheReportingApiConnector\EvalancheConnection;

$connection = EvalancheConnection::create(
    new EvalancheConfig(
        'your evalanche hostname (no uri, just the hostname)',
        'username',
        'password',
        Language::LANG_EN,
        TimeFormat::ISO8601,
    ),
    // $requestFactory, (optional existing PSR-17 RequestFactory instance)
    // $httpClient, (optional existing PSR-18 Http-Client instance)
);
```

The EvalancheConnection class provides one method for each table. E.g. the method `getPools()` queries the table 'pools'.

These methods each return a specific client class, e.g. `PoolsClient`, to specify further options and to receive the data in different formats.

A minimal working example could be:

```
$connection->getPools()->asXml();
```

The available methods follow the "Fluent Interface" pattern, which means they enable method chaining.

The call of a format method like `asXml()` or `asCsv()` is always the last call in the chain, as it returns the data.

#### Methods

[](#methods)

The following methods are available:

- `getArticleReferences(int $customer_id)`
- `getCustomers()`
- `getForms()`
- `getGeoCoordinates(int $customer_id)`
- `getLeadpages(int $customerId = null)`
- `getMailings()`
- `getMilestoneProfiles(int $customer_id)`
- `getNewsletterSendlogs(int $customer_id)`
- `getPools()`
- `getProfileChangelogs(int $pool_id)`
- `getProfiles(int $pool_id)`
- `getProfileScores()`
- `getResourceTypes()`
- `getScoringCluster()`
- `getScoringGroups()`
- `getScoringHistory()`
- `getTrackingHistory()`
- `getTrackingTypes()`

#### Formats

[](#formats)

At the current state you can choose between the following formats:

##### JsonArray

[](#jsonarray)

Example:

```
$connection->getPools()->asJsonArray();
```

Returns an array of stdClass objects.

##### JsonObject

[](#jsonobject)

Example:

```
$connection->getPools()->asJsonObject();
```

Returns a stdClass object.

##### XML

[](#xml)

Example:

```
$connection->getPools()->asXml();
```

Returns a string, containing valid xml.

##### CSV

[](#csv)

Example:

```
$connection->getPools()->asCsv();
```

Returns a string with comma separated values. The first line contains the column titles.

#### Parameters

[](#parameters)

Some tables provide further options or mandatory parameters:

##### Customer id (int)

[](#customer-id-int)

Use it to get the results for a specific customer, instead of the current customer.

###### Example:

[](#example)

```
$connection->getLeadpages(1234)->asJsonArray();
```

###### Provided by:

[](#provided-by)

- getLeadpages (optional)
- getNewsletterSendlogs

##### Pool id (int)

[](#pool-id-int)

Id of the pool you want to get results for.

###### Example:

[](#example-1)

```
$connection->getProfiles(123)->asJsonArray();
```

###### Provided by:

[](#provided-by-1)

- getProfiles
- getLeadpages

#### Time restrictions

[](#time-restrictions)

Limit the result to a defined time span by using the method `withTimeRestriction(string $from = null, string $to = null)`. Both parameters are optional and can be replaced by `null`.

###### Examples:

[](#examples)

Everything since yesterday:

```
$connection
    ->getMailings()
    ->withTimeRestriction('yesterday')
    ->asJsonArray();
```

From date to yesterday:

```
$connection
    ->getMailings()
    ->withTimeRestriction('2018-09-27', 'yesterday')
    ->asJsonArray();
```

Everything until yesterday:

```
$connection
    ->getMailings()
    ->withTimeRestriction(null, 'yesterday')
    ->asJsonArray();
```

###### Possible values:

[](#possible-values)

- date: `2018-08-03`, `03.08.2018`
- date and time: `03.08.2018 07:30`
- relative values: `yesterday`, `last monday`, `now-24hours` etc.

###### Provided by:

[](#provided-by-2)

- getMailings
- getNewsletterSendLogs
- getProfiles
- getScoringHistory
- getTrackingHistory

#### Language

[](#language)

Default language is English, but you can pass a different language code when establishing the connection.

Use the provided Enums in the class `\Scn\EvalancheReportingApiConnector\Enum\Language`

###### Example

[](#example-2)

```
use Scn\EvalancheReportingApiConnector\Enum\Language;
use Scn\EvalancheReportingApiConnector\EvalancheConnection;

$connection = EvalancheConnection::create(
    'given host',
    'given username',
    'given password',
    Language::LANG_DE
);
```

###### Possible values

[](#possible-values-1)

- English: `Language::LANG_EN`
- German: `Language::LANG_DE`
- Italian: `Language::LANG_IT`
- French: `Language::LANG_FR`

#### Time format

[](#time-format)

Default time format is iso8601, but you can pass a different format code when establishing the connection.

Use the provided Enums in the class `\Scn\EvalancheReportingApiConnector\Enum\TimeFormat`

###### Example

[](#example-3)

```
use Scn\EvalancheReportingApiConnector\EvalancheConnection;
use Scn\EvalancheReportingApiConnector\Enum\Language;
use Scn\EvalancheReportingApiConnector\Enum\TimeFormat;

$connection = EvalancheConnection::create(
    'given host',
    'given username',
    'given password',
    Language::LANG_DE,
    TimeFormat::UNIX,
);
```

###### Possible values

[](#possible-values-2)

- `TimeFormat::ISO8601`
- `TimeFormat::UNIX`
- `TimeFormat::RFC822`
- `TimeFormat::RFC850`
- `TimeFormat::RFC1036`
- `TimeFormat::RFC1123`
- `TimeFormat::RFC2822`
- `TimeFormat::RFC3339`
- `TimeFormat::W3C`

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

48

—

FairBetter than 95% of packages

Maintenance53

Moderate activity, may be stable

Popularity31

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity76

Established project with proven stability

 Bus Factor1

Top contributor holds 78.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~264 days

Recently: every ~317 days

Total

6

Last Release

1448d ago

Major Versions

v0.1.0 → v1.0.02018-12-10

1.0.x-dev → v2.0.02022-05-31

PHP version history (2 changes)v0.1.0PHP >=7.2

v2.0.0PHP ^8.0||^8.1

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/571575?v=4)[scn](/maintainers/scn)[@scn](https://github.com/scn)

---

Top Contributors

[![usox](https://avatars.githubusercontent.com/u/5184763?v=4)](https://github.com/usox "usox (26 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (4 commits)")[![WorksDev](https://avatars.githubusercontent.com/u/6623695?v=4)](https://github.com/WorksDev "WorksDev (2 commits)")[![effectpet](https://avatars.githubusercontent.com/u/16230418?v=4)](https://github.com/effectpet "effectpet (1 commits)")

---

Tags

apiconnectorevalanchephpapireportingconnectoremail marketingevalanche

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan, Rector

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/scn-evalanche-reporting-api-connector/health.svg)

```
[![Health](https://phpackages.com/badges/scn-evalanche-reporting-api-connector/health.svg)](https://phpackages.com/packages/scn-evalanche-reporting-api-connector)
```

###  Alternatives

[openai-php/client

OpenAI PHP is a supercharged PHP API client that allows you to interact with the Open AI API

5.8k22.6M232](/packages/openai-php-client)[getbrevo/brevo-php

Official Brevo provided RESTFul API V3 php library

963.1M35](/packages/getbrevo-brevo-php)[theodo-group/llphant

LLPhant is a library to help you build Generative AI applications.

1.5k311.5k5](/packages/theodo-group-llphant)[wordpress/php-ai-client

A provider agnostic PHP AI client SDK to communicate with any generative AI models of various capabilities using a uniform API.

26236.6k14](/packages/wordpress-php-ai-client)[swisnl/json-api-client

A PHP package for mapping remote JSON:API resources to Eloquent like models and collections.

211473.2k12](/packages/swisnl-json-api-client)[telnyx/telnyx-php

Official Telnyx PHP SDK — APIs for Voice, SMS, MMS, WhatsApp, Fax, SIP Trunking, Wireless IoT, Call Control, and more. Build global communications on Telnyx's private carrier-grade network.

35636.1k2](/packages/telnyx-telnyx-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)