matomo-org / matomo-org/developer-documentation

Provide a guide how to use the HTTP Tracking API

Open
#78 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation
Dominant language
PHP
Stars
58
Forks
88
Avg merge
6d 3h
Merged PRs (30d)
13

Description

When going to the [Integrate](http://developer.piwik.org/integration) page we see a couple of Tracking guides. The first two links "JS Tracking Client" and "Tracking API Clients" list clients that access the HTTP Tracking API. The third link is a guide how to use Content-Tracking via the HTTP Tracking API but there is actually no guide how to use the HTTP Tracking API which would be helpful if people want to write a client or if they want to track data in their application without using any of those clients.

I don't think we need a huge guide here but we need to explain some basics and the link to the [Tracking API Reference](http://developer.piwik.org/api-reference/tracking-api).

At the end of the API Reference there is for example one part "Debugging the Tracker" which could be part of the guide. How to construct an example request could be moved there as well and explained in steps. We also need to explain when authentication is needed and how they can test it etc.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Integrate page and the Tracking API Reference, especially the existing “Debugging the Tracker” section. Outline a standalone guide covering example request construction, authentication, testing, and links to the reference; done means the guide is linked from Integrate and explains the basic HTTP Tracking API workflow.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.