Schema API

Important: Read the intro before proceeding.

Overview

Please read about Schemas before proceeding.

Action Schema JSON format

 {
         "template": "**${visitor.name}** viewed [${action.title}](http://${action.d}${action.url})",
         "icon": "files/document---generic.png",
         "details": {
             "title": "Page View",
             "description": "Visitor loaded a page"
         },
         "eventName": "pv",
         "fields": [{
             "aggregate": "group",
             "type": "string",
             "key": "url"
              },
               {
             "aggregate": "group",
             "type": "string",
             "key": "title"
     }]
 }

Visitor Schema JSON format

  {
         "propertyName": "email",
         "aggregate": "unique",
         "details": {
             "title": "Email",
             "order": 1,
             "description": "Visitor email address"
         },
         "type": "string"
 }

CRUD Operations

Create Action Schema

Endpoint

http(s)://www.woopra.com/rest/[version]/schemata/action/add

Parameters

Name Description
website
schema Action JSON

Delete Action Schema

Endpoint

http(s)://www.woopra.com/rest/[version]/schemata/action/delete

Parameters

Name Description
website
name Action Schema’s “eventName”

Create Visitor Schema

Endpoint

http(s)://www.woopra.com/rest/[version]/schemata/visitor/add

Parameters

Name Description
website
schema Visitor JSON

Delete Visitor Schema

Endpoint

http(s)://www.woopra.com/rest/[version]/schemata/visitor/delete

Parameters

Name Description
website
name Visitor Schema’s “propertyName”

List All Schemas

Endpoint

http(s)://www.woopra.com/rest/[version]/schemata/get

Parameters

Name Description
website

Do you know what your customers are doing?
Find out in 5 minutes.

Try Woopra for free. No credit cards. No obligations.

Start for free