PIpiwik
Apps

App add

It adds app

post/api/apps/v2

Request

Request body

Example request

{
  "data": {
    "type": "ppms/app",
    "attributes": {
      "id": "985ed9d7-b652-47b8-b9cf-c17d62735261",
      "appType": "web",
      "name": "AppName",
      "urls": [
        "https://example.com"
      ],
      "timezone": "UTC",
      "currency": "USD",
      "keepUrlFragment": true,
      "eCommerceTracking": true,
      "siteSearchTracking": true,
      "siteSearchQueryParams": [
        "q",
        "query",
        "s",
        "search",
        "searchword",
        "keyword"
      ],
      "siteSearchCategoryParams": [],
      "delay": 500,
      "excludedIps": [
        "192.168.0.0",
        "172.16.0.0",
        "1.2.*.*",
        "2607:f0d0:1002:51::4",
        "::7:*"
      ],
      "excludedUrlParams": [
        "pl_medium",
        "pk_source",
        "fb_comment_id",
        "/^sess.*|.*[dD]ate$/"
      ],
      "excludedUserAgents": [
        "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0",
        "Opera/9.80 (Windows NT 6.2; Win64; x64) Presto/2.12 Version/12.16"
      ],
      "gdpr": true,
      "privacyCookieExpirationPeriod": 31536000,
      "privacyCookieDomains": [
        "*.example.com",
        "example.com"
      ],
      "gdprLocationRecognition": true,
      "gdprDataAnonymization": true,
      "cmp": "piwik"
    }
  }
}

Response

Created

Example response

{
  "data": {
    "type": "ppms/app",
    "id": "985ed9d7-b652-47b8-b9cf-c17d62735261",
    "attributes": {
      "organization": "default",
      "appType": "web",
      "addedAt": "2018-07-10T08:50:41+00:00",
      "updatedAt": "2018-09-01T10:25:11+00:00",
      "name": "AppName",
      "urls": [
        "https://example.com"
      ],
      "timezone": "UTC",
      "currency": "USD",
      "keepUrlFragment": true,
      "eCommerceTracking": true,
      "siteSearchTracking": true,
      "siteSearchQueryParams": [
        "q",
        "query",
        "s",
        "search",
        "searchword",
        "keyword"
      ],
      "siteSearchCategoryParams": [],
      "delay": 500,
      "excludedIps": [
        "192.168.0.0",
        "172.16.0.0",
        "1.2.*.*",
        "2607:f0d0:1002:51::4",
        "::7:*"
      ],
      "excludedUrlParams": [
        "pl_medium",
        "pk_source",
        "fb_comment_id",
        "/^sess.*|.*[dD]ate$/"
      ],
      "excludedUserAgents": [
        "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0",
        "Opera/9.80 (Windows NT 6.2; Win64; x64) Presto/2.12 Version/12.16"
      ],
      "gdpr": true,
      "privacyCookieExpirationPeriod": 31536000,
      "privacyCookieDomains": [
        "*.example.com",
        "example.com"
      ],
      "gdprLocationRecognition": true,
      "gdprDataAnonymization": true,
      "cmp": "piwik"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.