Download the PHP package scn/evalanche-reporting-api-connector without Composer
On this page you can find all versions of the php package scn/evalanche-reporting-api-connector. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download scn/evalanche-reporting-api-connector
More information about scn/evalanche-reporting-api-connector
Files in scn/evalanche-reporting-api-connector
Package evalanche-reporting-api-connector
Short Description Official PHP client for Evalanche Reporting API
License MIT
Homepage https://github.com/SC-Networks/evalanche-reporting-api-connector
Informations about the package evalanche-reporting-api-connector
EVALANCHE REPORTING API CONNECTOR
Install
Via Composer
Usage
General
First create a connection with the access credentials provided by SC-Networks.
The EvalancheConnection class provides one method for each table. E.g. the method queries the table 'pools'.
These methods each return a specific client class, e.g. , to specify further options and to receive the data in different formats.
A minimal working example could be:
The available methods follow the "Fluent Interface" pattern, which means they enable method chaining.
The call of a format method like or is always the last call in the chain, as it returns the data.
Methods
The following methods are available:
Formats
At the current state you can choose between the following formats:
JsonArray
Example:
Returns an array of stdClass objects.
JsonObject
Example:
Returns a stdClass object.
XML
Example:
Returns a string, containing valid xml.
CSV
Example:
Returns a string with comma separated values. The first line contains the column titles.
Parameters
Some tables provide further options or mandatory parameters:
Customer id (int)
Use it to get the results for a specific customer, instead of the current customer.
Example:
Provided by:
- getLeadpages (optional)
- getNewsletterSendlogs
Pool id (int)
Id of the pool you want to get results for.
Example:
Provided by:
- getProfiles
- getLeadpages
Time restrictions
Limit the result to a defined time span by using the method . Both parameters are optional and can be replaced by .
Examples:
Everything since yesterday:
From date to yesterday:
Everything until yesterday:
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:
- getMailings
- getNewsletterSendLogs
- getProfiles
- getScoringHistory
- getTrackingHistory
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
Possible values
- English:
Language::LANG_EN
- German:
Language::LANG_DE
- Italian:
Language::LANG_IT
- French:
Language::LANG_FR
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
Possible values
TimeFormat::ISO8601
TimeFormat::UNIX
TimeFormat::RFC822
TimeFormat::RFC850
TimeFormat::RFC1036
TimeFormat::RFC1123
TimeFormat::RFC2822
TimeFormat::RFC3339
TimeFormat::W3C
License
The MIT License (MIT). Please see License File for more information.
All versions of evalanche-reporting-api-connector with dependencies
ext-json Version *
psr/http-client Version ^1.0
php-http/discovery Version ^1.13
psr/http-message Version ^1.0
psr/http-factory Version ^1.0