Skip to content

Commit

Permalink
Update tables
Browse files Browse the repository at this point in the history
  • Loading branch information
Adspect committed Apr 20, 2024
1 parent c270487 commit 6facda5
Show file tree
Hide file tree
Showing 2 changed files with 102 additions and 57 deletions.
14 changes: 8 additions & 6 deletions reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
Adspect reporting is a comprehensive and valuable source of analytical information on your affiliate campaigns
performance and traffic quality. It lets you do the following:

- Evaluate traffic quality wholly or per source, publisher, ad spot, etc;
- Build sales funnels of various depth and with flexible filtering by any traffic attributes;
- Obtain detailed information about any particular click;
- Download reports in [CSV format](https://en.wikipedia.org/wiki/Comma-separated_values).
* Evaluate traffic quality wholly or per source, publisher, ad spot, etc;
* Build sales funnels of various depth and with flexible filtering by any traffic attributes;
* Obtain detailed information about any particular click;
* Download reports in [CSV format](https://en.wikipedia.org/wiki/Comma-separated_values).

Reporting section in your clients area is split into three parts:

Expand All @@ -20,9 +20,11 @@ You may delete data by these parameters from Adspect reporting by pressing the D
Both tables have a Download .CSV button in the bottom left corner, for downloading reports in CSV format.
You may import them into Microsoft Excel, Apple Numbers, Google Sheets, or similar spreadsheet software.

*Please do not select overly broad date ranges as it will lead to huge dataset fetching and additional strain
:::{important}
Please do not select overly broad date ranges as it will lead to huge dataset fetching and additional strain
on our servers. We limit the total number of rows that will be included in a report, so you may get an incomplete
report if its date range is too broad.*
report if its date range is too broad.
:::

## Sales Funnels

Expand Down
145 changes: 94 additions & 51 deletions streams.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,49 +130,6 @@ by the stream; see the [Rotator paragraph](#rotator) below.
The ON checkbox allows you to turn individual money pages on or off. This is convenient for removing
poorly performing offers or landing pages from A/B testing without deleting them from the list.

#### URL Macros

Adspect supports several URL macros that you can use in money and safe page fields:

| Macro | Description |
|:----------------|:------------|
| `{sid}` | Stream identifier. |
| `{aid}` | Account identifier. |
| `{host}` | Domain name of the requested website. |
| `{ip}` | IP address of the visitor. |
| `{asn}` | [Autonomous system](https://en.wikipedia.org/wiki/Autonomous_system_(Internet)) number of the visitor. |
| `{useragent}` | [User agent string](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) of the visitor. |
| `{referrer}` | [Referrer](https://developer.mozilla.org/en-US/docs/Web/API/Document/referrer) of the visitor. |
| `{cost}` | [Click cost](streams.md#cost). |
| `{subid}` | [Sub ID](streams.md#sub-id). |
| `{clickid}` | [Click ID](streams.md#click-id). |
| `{country}` | Two-letter country code of the visitor. |
| `{os}` | Operating system of the visitor with version for Windows and Android. |
| `{browser}` | Name of the browser of the visitor. |
| `{engine}` | Name of the browser engine of the visitor. |
| `{epoch}` | [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) of the visit. |
| `{tags}` | [Click processing tags](reporting.md#raw-report-columns), if any. |
| `{p:parameter}` | Value of the specified parameter in the request URL. |
| `{h:header}` | Value of the specified request header. |

When using the local file action, you may still add parameters with macros after the file name of your
money/safe page, and they will be parsed and made available in PHP in the
[`$_GET` superglobal variable](https://www.php.net/manual/en/reserved.variables.get.php).

URL example:
```
https://example.com/offer?clickid={clickid}&geo={country}&os={os}
```

Local file example:
```
page.php?clickid={clickid}&geo={country}&os={os}
```
Values of these macros may be accessed in page code as follows:
```php
<a href="https://example.com/offer?clickid=<?= $_GET['clickid'] ?>">Offer</a>
```

### Rotator

Rotator controls how several money pages are rotated, i.e. how the system decides which money page to display to each
Expand Down Expand Up @@ -205,8 +162,93 @@ This is the safe page to show to moderators, robots, scrapers, etc. It should n
that may put your affiliate campaign in danger or in violation of any rules. Everything described above for
the money page fields also applies to the safe page.

**In most cases, your safe page MUST be displayed without redirects!** Consider using either a local file
or a reverse proxy action.
:::{important}
In most cases, your safe page MUST be displayed without redirects! Consider using either a local file or a reverse proxy action.
:::

(macros)=
### URL Macros

Adspect supports several URL macros that you can use in money and safe page fields:

:::{list-table}
:header-rows: 1

* - Macro
- Description

* - `{sid}`
- Stream ID.

* - `{aid}`
- Account ID.

* - `{host}`
- Domain name of the requested website.

* - `{ip}`
- IP address.

* - `{asn}`
- [Autonomous system number (ASN)](https://en.wikipedia.org/wiki/Autonomous_system_(Internet)).

* - `{useragent}`
- [User agent string](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent).

* - `{referrer}`
- [Referrer](https://developer.mozilla.org/en-US/docs/Web/API/Document/referrer).

* - `{cost}`
- [Click cost](streams.md#cost).

* - `{subid}`
- [Sub ID](streams.md#sub-id).

* - `{clickid}`
- [Click ID](streams.md#click-id).

* - `{country}`
- Country code in [two-letter format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).

* - `{os}`
- Operating system.

* - `{browser}`
- Browser.

* - `{engine}`
- Browser engine.

* - `{epoch}`
- [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time) of the visit.

* - `{tags}`
- [Click tags](reporting.md#tags), if any.

* - `{p:parameter}`
- Value of the specified request URL parameter.

* - `{h:header}`
- Value of the specified request header.
:::

When using the local file action, you may still add parameters with macros after the file name of your
money/safe page, and they will be parsed and made available in PHP in the
[`$_GET` superglobal variable](https://www.php.net/manual/en/reserved.variables.get.php).

URL example:
```
https://example.com/offer?clickid={clickid}&geo={country}&os={os}
```

Local file example:
```
page.php?clickid={clickid}&geo={country}&os={os}
```
Values of these macros may be accessed in page code as follows:
```php
<a href="https://example.com/offer?clickid=<?= $_GET['clickid'] ?>">Offer</a>
```

## Actions

Expand Down Expand Up @@ -429,6 +471,7 @@ Redirect via `location.replace()`.

This group of settings control most of the built-in traffic filters of Adspect.

(filtering-level)=
### Filtering Level

Filtering level lets you adjust aggressiveness of traffic filtering by selecting one of several pre-defined levels.
Expand All @@ -439,23 +482,23 @@ Filtering level lets you adjust aggressiveness of traffic filtering by selecting
* - Level
- Description

* - Essentially off
* - 0. Essentially off
- All built-in and third-party filtering databases are disabled. VLA™ machine learning is not used. Do not use use this level
unless you have a compelling reason.

* - Low
* - 1. Low
- Only the most blatant offenders are blocked: big corporations, largest datacenters and hosting providers, antivirus companies,
etc. VLA™ machine learning is not used. This level fits best for in-app and WebView cloaking.

* - Medium
* - 2. Medium
- All the IT corporations, datacenters, hosting providers, and IP transit networks are blocked. VLA™ machine learning is enabled.
All clicks are also checked with the top twelve competing cloaking services.

* - High
* - 3. High
- Same as Medium, plus IP network ownership history of up to 3 years back is checked for all the blocked organizations. Third-party
filtering databases and risk scoring companies are also queried. This level is safe for most scenarios.

* - Paranoid
* - 4. Paranoid
- Same as High, plus all the government, military, scientific, and educational organizations are blocked, as well as certain high
risk Internet service providers. This level is the safest, but may result in high bleed rate.
:::
Expand Down Expand Up @@ -671,7 +714,7 @@ URL rules allow you to check and manipulate URL parameter values. Each rule con

* **Parameter name** -- this is the name of the URL parameter that will be checked or altered;
* **Operator** -- specific check or operation that will be executed;
* **Argument** -- argument of the operator, if applicable (macros are supported);
* **Argument** -- argument of the operator, if applicable ([macros are supported](streams.md#macros));
* **ON checkbox** -- turns a rule on or off.

:::{table} URL Rule Operators
Expand Down

0 comments on commit 6facda5

Please sign in to comment.