Skip to content

API Docs

Originate Organic Share

Create an organic short link

Authentication: Must be authenticated
EndPoint: /v1/pointzi/originate_organic_share
Method: POST

Parameter Description/Notes
title (required) a friendly name for this link
utm_campaign (required) Used for keyword analysis. Use utm_campaign to identify a specific product promotion or strategic campaign. Example: utm_campaign=spring_sale
utm_source (required) Use utm_source to identify a search engine, newsletter name, or other source. Example: utm_source=google
utm_medium (required) Use utm_medium to identify a medium such as email or cost-per-click. Example: utm_medium=cpc
utm_content (optional) Use for A/B testing and content-targeted ads. Use utm_content to differentiate links that point to the same URL. Examples: utm_content=logolink or utm_content=textlink
utm_term (optional) Use utm_term to note the keywords for this link. Example: utm_term=running+
scheme (optional) scheme that App has registered to achieve deep linking. Example: fb for Facebook
uri (optional) uri that App can parse to display a deep linked page. Example: profile/12345
destination_url_default (optional) short link specific fallback url which will be shown to user when accessing the link via desktop or mobile other than iOS/Android platforms.

Returns:

{
    "code": 0,
    "value": {
        "share_guid_url": "http://hwk.io/s/abcdef"
    }
}

Get Share

Returns all short links associated with an App

Authentication: Must be authenticated.
EndPoint: /v1/pointzi/get_share
Method: GET

Parameter Description/Notes
count (optional) Returns the number of objects as an integer instead of a list.
type (optional) Can be either 'organic' (links generated from console) or 'viral'(links generated in-apps)
limit (optional) Limits the number of returned objects. Default is 20, maximum is a 100 no matter what limit is set to.
offset(optional) Skips the first offset objects.
installid(optional) Return all short links associated with this installid rather than App.

Returns:

{
"code": 0,
"value": [
    {
"title": "FB Link 1",
"app_key": "Facebook",
"sh_cuid": "eric@gmail.com",
"scheme": "fb",
"uri": "profile/123456",
"destination_url_default": "https://www.facebook.com/profile/123456",
"share_guid_url": "http://hwk.io/s/abcdef",
"share_datetime": "2015-06-18 04:03:46.827355",
"utm_campaign": "summer_sale",
"utm_source": "facebook",
"utm_medium": "cpc",
"utm_content": "logolink",
"utm_term": "running+",
"type": "organic",
"installs": 100, ------------------> how many installs the link achieves
"clicks": 500, ------------------> how many clicks on this link
"not_installed_clicks": 300, -> how many clicks are on a device which doesn't have the app installed
"installed_clicks": 200 --------> how many clicks are on a device which does have the app installed
"real_sources": {"facebook":400, "twitter": 100} ---->  this field tells you the number of clicks coming from different actual sources
    },
    {...}
  ]
}

Graph

Returns a list of vertices and a list of edges to represent app growth

Authentication: Must be authenticated.
EndPoint: v1/statistics/pointzi/graph
Method: GET

Parameter Description/Notes
type (optional) Can be either 'organic' (links generated from console) or 'viral'(links generated in-apps)

Returns:

{
"code": 0,
"value": {
    "nodes": 
    [
{
    "group": 1,
    "name": "jack@gmail.com",
    "shares": 1
},
{
    "group": 1,
    "name": "mary@gmail.com",
    "shares": 1
},
{
    "group": 1,
    "name": "eric@gmail.com",
    "shares": 0
},
{..}
    ],
    "links": 
    [
        {
            "source": 0,
            "target": 1,
            "value": 1
        },
        {
            "source": 1,
            "target": 2,
            "value": 1
        },
        {..}
    ]
  }
}

Performance

Returns details of all installs the provided short link achieved.

Authentication: Must be authenticated.
EndPoint: /v1/pointzi/performance
Method: GET

Parameter Description/Notes
share_guid_url (required) the short link url (eg. http://hwk.io/s/abcdef)
count (optional) Returns the number of objects as an integer instead of a list.
limit (optional) Limits the number of returned objects. Default is 20, maximum is a 100 no matter what limit is set to.
offset (optional) Skips the first offset objects.

Returns:

{
   "code":0,
   "value": [
   {
"installid":"AAAAAAAA",
"installer_ip":"111.111.111.111",
"installer_sh_cuid": "eric@gmail.com",
"installer_datetime": "2015-06-18 05:51:18.555637",
"share_ip": "111.111.111.112",
"share_datetime": "2015-06-17 15:25:38.873641",
"originator_share_guid_url": "http://hwk.io/s/abcdef",
"originator_sh_cuid": "mary@gmail.com",
"originator_utm_campaign": "summer_sales",
"originator_utm_source": "facebook",
"originator_utm_medium": "cpc",
"originator_utm_content": "logolink",
"originator_utm_term": "running+",
"originator_ip": "222.222.222.222",
"originator_installed_clicks": 500,
"originator_not_installed_clicks": 1000,
"originator_installs": 300,
"originator_clicks": 1500,
"originator_destination_url_default": "https://www.facebook.com/profile/123456",
"originator_title": "FB Link 1",
"originator_from_console": true,
"originator_scheme": "fb",
"originator_uri": "profile/123456",
"app_key": "Facebook"
   },
   {...}
 ]
}

Get Channels

Returns an App's total installs and(or) total clicks over a time period.

Authentication: Must be authenticated.
EndPoint: /v1/statistics/pointzi/channels
Method: GET

Parameter Description/Notes
period (optional) Must be one of these ('1d', '7d', '14d', '30d', '90d', '12w', '30w', '6m', '12m', '1y') where 'd' stands for day,
'w' stands for week, 'm' stands for month and 'y' stands for year.
The default value is 30d if not provided.
channel (optional) Must be one of these ('utm_source','real_source', 'utm_campaign', 'utm_medium', 'utm_term', 'utm_content')
The default value is utm_source if not provided.
show_count (optional) Can be either 'install' or 'click'. The default setting will show both if not provided.
utm_campaign (optional) Filter over utm_campaign. See Originate Organic Share endpoint above for details.
utm_source (optional) Filter over utm_source. See Originate Organic Share endpoint above for details. If multiple sources are targeted,
please use '+' to merge queries. For example: utm_source=facebook+twitter
real_source (optional) Filter over real_source. It is the place where users click share links from. For example: mobile.twitter.com, m.facebook.com. If multiple sources are targeted, please use '+' to merge queries. For example: real_source=m.facebook.com+mobile.twitter.com
utm_medium (optional) Filter over utm_medium. See Originate Organic Share endpoint above for details.
utm_content (optional) Filter over utm_content. See Originate Organic Share endpoint above for details.
utm_term (optional) Filter over utm_term. See Originate Organic Share endpoint above for details.
type (optional) Can be either 'organic' (links generated from console) or 'viral'(links generated in-apps)

Returns: (example return for v1/statistics/pointzi/channels?period=6m&channel=utm_campaign)

{
    "code": 0,
    "value": [
        {
            "utm_campaign": "summer sales",
            "click_count": [
                130,
                80,
                99,
                250,
                300,
                290
            ],
            "install_count": [
                80,
                22,
                45,
                52,
                66,
                33
            ],
            "label": [
                "January",
                "February",
                "March",
                "April",
                "May",
                "June"
            ]
        }
    ]
}

Get K-Factor

Returns K-factor for all users of the provided App

Authentication: Must be authenticated.
EndPoint: /v1/pointzi/get_k_factor
Method: GET

Parameter Description/Notes
count (optional) Returns the number of objects as an integer instead of a list.
limit (optional) Limits the number of returned objects. Default is 20, maximum is a 100 no matter what limit is set to.
offset (optional) Skips the first offset objects.

Returns:

{
    "code": 0,
    "value": [
        {
            "installid": "B6FJ0CJMJA6SUBTT",
            "k_factor": 0.887
        }
    ]
}