API Events and Logging
From ePrize Developers Wiki
(Difference between revisions)
(New page: TODO: organize and explain. Add the following request header to any API call: X-eWS-Activity: {activity-name} {activity-name} must be one of: login, register, play) |
|||
| (One intermediate revision not shown.) | |||
| Line 1: | Line 1: | ||
| - | + | {{Logo}} | |
| - | + | The eWS API consists of small, simple bricks that you assemble into a promotion. However, reporting on events that happen in your promotion don't really line up with these small bricks—you'd like to know about bigger events. To do that, add the following HTTP header to any eWS API request. | |
| - | + | ||
| + | <pre> | ||
X-eWS-Activity: {activity-name} | X-eWS-Activity: {activity-name} | ||
| + | </pre> | ||
| - | {activity-name} must be one of: login, register, play | + | {activity-name} must be one of: login, register, play. You should pick one of the eWS API requests that best represents the given activity and tag only that one request. If you tag multiple requests with the same activity, each one will be reported as that activity. |
Current revision
The eWS API consists of small, simple bricks that you assemble into a promotion. However, reporting on events that happen in your promotion don't really line up with these small bricks—you'd like to know about bigger events. To do that, add the following HTTP header to any eWS API request.
X-eWS-Activity: {activity-name}
{activity-name} must be one of: login, register, play. You should pick one of the eWS API requests that best represents the given activity and tag only that one request. If you tag multiple requests with the same activity, each one will be reported as that activity.
