Skip to content

Commit

Permalink
Reporting API (WIP)
Browse files Browse the repository at this point in the history
  • Loading branch information
Adspect committed Apr 13, 2024
1 parent 8f3caac commit d670506
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions reporting-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ These endpoints functionally mirror the [Reporting section](reporting.md) of the
(reporting-filters)=
### Reporting Filters

Both Reporting API endpoints support filters via URL parameters to narrow down the portion of statistics data to be processed, e.g:
Both endpoints support filters via URL parameters to narrow down the portion of statistics data to be processed, e.g:

```
...&date_from=1672520400&date_to=1675198800&country_code[]=AE&os[]=iOS&os[]=macOS
date_from=1672520400&date_to=1675198800&country_code[]=AE&os[]=iOS&os[]=macOS
```

A report made with such filters will only contain clicks and conversions that match **all** of the following conditions:
Expand Down Expand Up @@ -101,7 +101,7 @@ logical **OR** condition, e.g. `os[]=iOS&os[]=macOS` will extract clicks and con

* - `target[]`
- Integer
- Filter by displayed page:<br>
- Filter by displayed page:<br><br>
0 -- safe page<br>
1--255 -- money page with the corresponding ordinal number
:::
Expand Down Expand Up @@ -186,7 +186,7 @@ The following table lists available breakdown columns for the `group_by[]` URL p
- Stream mode at the moment of the click.

* - `target`
- Displayed page:<br>
- Displayed page:<br><br>
0 -- safe page<br>
1--255 -- money page with the corresponding ordinal number

Expand Down Expand Up @@ -238,46 +238,46 @@ Please specify only those metrics that you actually need in your API requests.
- [Sophisticated invalid traffic](https://insider.integralads.com/givt-vs-sivt-invalid-traffic/), that is, the number of browser fingerprints that Adspect consciously filtered out as bad traffic.

* - `mia`
- Clicks missing in action, the figure computed as the number of visitors that failed to produce or submit a browser fingerprint. As mentioned above, these are often dumb bots with missing JavaScript support. Another common reason is network latency, especially evident in traffic with slow connection rates, e.g. 3G/EDGE, when visitors manage to close the tab or window before their fingerprint is submitted.
- Clicks missing in action, the figure =&nbsp;the number of visitors that failed to produce or submit a browser fingerprint. As mentioned above, these are often dumb bots with missing JavaScript support. Another common reason is network latency, especially evident in traffic with slow connection rates, e.g. 3G/EDGE, when visitors manage to close the tab or window before their fingerprint is submitted.

* - `quality`
- Percentage of money hits in the whole click volume. This is the best metric for evaluating traffic quality as a whole and may be used to compare different traffic sources, publishers, ad spots, etc. Especially useful with grouping by sub ID for compiling blacklists of bot-ridden zones, as described in [the dedicated paragraph](use-cases.md#detecting-bot-zones).

* - `expenses`
- Total traffic cost computed as a sum of costs of each click, if passed via URL parameter.
- Total traffic cost computed as a sum of costs of each click, [if passed in a click URL parameter](streams.md#cost).

* - `conversions`
- Total number of conversions as accounted via the postback mechanism.
- Total number of conversions.

* - `cr`
- Conversion rate computed as conversions&nbsp;/&nbsp;clicks.
- Conversion rate =&nbsp;conversions&nbsp;/&nbsp;clicks.

* - `revenue`
- Gross revenue of the funnel as accounted via the postback mechanism.
- Total revenue computed as a sum of payouts of each conversion, [if passed in postback](tracker.md#postback).

* - `profit`
- Net profit computed as revenue&nbsp;&nbsp;cost.
- Net profit =&nbsp;revenue&nbsp;&nbsp;cost.

* - `roi`
- Return on investment computed as profit&nbsp;/&nbsp;cost.
- Return on investment =&nbsp;profit&nbsp;/&nbsp;cost.

* - `cpc`
- Cost per click computed as cost&nbsp;/&nbsp;clicks.
- Cost per click =&nbsp;cost&nbsp;/&nbsp;clicks.

* - `cpm`
- Cost per mille computed as cost&nbsp;/&nbsp;clicks&nbsp;×&nbsp;1000.
- Cost per mille (thousand clicks) =&nbsp;cost&nbsp;/&nbsp;clicks&nbsp;×&nbsp;1000.

* - `cpa`
- Cost per action computed as cost&nbsp;/&nbsp;conversions.
- Cost per action =&nbsp;cost&nbsp;/&nbsp;conversions.

* - `epl`
- Earn per lead computed as revenue&nbsp;/&nbsp;conversions.
- Earn per lead =&nbsp;revenue&nbsp;/&nbsp;conversions.

* - `ecpc`
- Effective cost per click computed as revenue&nbsp;/&nbsp;clicks.
- Effective cost per click =&nbsp;revenue&nbsp;/&nbsp;clicks.

* - `ecpm`
- Effective cost per mille computed as revenue&nbsp;/&nbsp;clicks&nbsp;×&nbsp;1000.
- Effective cost per mille (thousand clicks) =&nbsp;revenue&nbsp;/&nbsp;clicks&nbsp;×&nbsp;1000.
:::

:::{tip}
Expand Down Expand Up @@ -400,13 +400,13 @@ Please specify only those columns that you actually need in your API requests.
- Stream mode at the moment of the click.

* - `sequence`
- Click processing stage:<br>
- Click processing stage:<br><br>
0 -- basic check<br>
1 -- JavaScript fingerprint check<br>
255 -- conversion

* - `target`
- Displayed page:<br>
- Displayed page:<br><br>
0 -- safe page<br>
1--255 -- money page with the corresponding ordinal number

Expand Down

0 comments on commit d670506

Please sign in to comment.