Sharing Analytics API \ Retrieve snapshot details PHP SDK

Resource/URI GET POST PUT DELETE
Sharing Analytics Snapshots /sharing/analytics/snapshots.json List all snapshots – Initiate a new snapshot –
Sharing Analytics Snapshot /sharing/analytics/snapshots/<sharing_analytics_snapshot_token>.json Retrieve snapshot details – – Delete a snapshot

Workflow

Request: the code to send to the API

Send a GET request to /sharing/analytics/snapshots/<sharing_analytics_snapshot_token>.json to obtain the details of an existing snapshot. The <sharing_analytics_snapshot_token> has to be replaced by the unique token of an existing snapshot.

Result: the code returned by the API

The API will return the details of the corresponding snapshot. Depending on the social network, more or less information is available. The API always returns standardized results that are similar to the example below.

Example Resultset

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
{
  "response": {
    "request": {
      "date": "Fri, 27 Jan 2012 19:12:19 +0100",
      "resource": "/sharing/analytics/snapshots/4384c29a-4ef0-4953-b3a0-b1c0a50a9771.json",
      "status": {
        "flag": "success",
        "code": 200,
        "info": "Your request has been processed successfully"
      }
    },
    "result": {
      "data": {
        "sharing_analytics_snapshot": {
          "sharing_analytics_snapshot_token": "4384c29a-4ef0-4953-b3a0-b1c0a50a9771",
          "date_initiated": "Fri, 27 Jan 2012 17:57:05 +0100",
          "date_finished": "Fri, 27 Jan 2012 19:04:38 +0100",
          "sharing_message": {
            "sharing_message_token": "dd26b533-5545-4ca1-bce0-91586799f426",
            "date_creation": "Fri, 27 Jan 2012 17:55:32 +0100",
            "date_last_published": "Fri, 27 Jan 2012 17:55:32 +0100"
          },
          "publication_snapshots": {
            "count": 2,
            "entries": [    
              {
                "publication": {
                  "provider": "twitter",
                  "user_token": "a96318d1-16a4-4461-8e7e-977d78665194",
                  "identity_token": "3e2c84e9-44c4-441b-861b-9374e1c93d4e",
                  "date_publication": "Fri, 27 Jan 2012 17:55:32 +0100",
                  "shorturls": {
                    "count": 1,
                    "entries": [
                      {
                        "shorturl_token": "yCnsJ",
                        "original_url": "http://www.oneall.com",
                        "short_url": "http://oal.lu/yCnsJ",
                        "date_creation": "Fri, 27 Jan 2012 17:55:32 +0100",
                        "date_last_referral": "Fri, 27 Jan 2012 18:39:50 +0100",
                        "num_referrals": 12
                      }                
                    ]
                  }
                },
                "publication_snapshot": {
                  "date_processed": "Fri, 27 Jan 2012 19:04:38 +0100",
                  "status": {
                    "flag": "success",
                    "code": "200",
                    "message": "Message still exists"
                  },
                  "urls": {
                    "count": 1,
                    "data": [
                      {
                        "target": "http://www.oneall.com",
                        "num_referrals": "12",
                        "date_last_referral": "Fri, 27 Jan 2012 18:39:50 +0100"
                      }                     
                    ]
                  },
                  "likes": {
                    "count": 0
                  },
                  "comments": {
                    "count": 0
                  },
                  "retweets": {
                    "count": 2,
                    "entries": [
                      {
                        "username": "example_user_1",
                        "profileUrl": "http://www.twitter.com/example_user_1",
                        "num_followers": 500,
                        "data_member_since": "Fri, 27 Jan 2012 18:13:45 +0100"
                      },
                      {
                        "username": "example_user_2",
                        "profileUrl": "http://www.twitter.com/example_user_2",
                        "num_followers": 100,
                        "data_member_since": "Fri, 21 Jan 2012 18:13:45 +0100"
                      }
                    ]
                  }
                }
              },            
              {
                "publication": {
                  "provider": "facebook",
                  "user_token": "e859e757-5d5f-499d-b105-227b2d6a35a5",
                  "identity_token": "d8432de1-49a1-4b93-b95e-b2bde6a697c5",
                  "date_publication": "Wed, 21 Dec 2011 01:34:36 +0100",
                  "shorturls": {
                    "count": 1,
                    "entries": [
                      {
                        "shorturl_token": "n0o5d",
                        "original_url": "http://www.oneall.com/",
                        "short_url": "http://oal.lu/n0o5d",
                        "date_creation": "Wed, 21 Dec 2011 01:34:35 +0100",
                        "num_referrals": 63
                      }
                    ]
                  }
                },
                "publication_snapshot": {
                  "date_processed": "Thu, 26 Jan 2012 14:29:24 +0100",
                  "status": {
                    "flag": "success",
                    "code": 200,
                    "message": "Message still exists"
                  },
                  "urls": {
                    "count": 1,
                    "data": [
                      {
                        "target": "http://www.oneall.com/",
                        "num_referrals": "63"
                      }
                    ]
                  },
                  "likes": {
                    "count": 5,
                    "entries": [
                      {
                        "username": "Example User1",
                        "profileUrl": "http://www.facebook.com/profile.php?id=1"
                      },
                      {
                        "username": "Example User2",
                        "profileUrl": "http://www.facebook.com/profile.php?id=2"
                      },
                      {
                        "username": "Example User3",
                        "profileUrl": "http://www.facebook.com/profile.php?id=3"
                      },
                      {
                        "username": "Example User4",
                        "profileUrl": "http://www.facebook.com/profile.php?id=4"
                      },
                      {
                        "username": "Example User5",
                        "profileUrl": "http://www.facebook.com/profile.php?id=5"
                      },
                    ]
                  }            
                  "comments": {
                    "count": 4,
                    "entries": [
                      {
                        "date": "Thu, 26 Jan 2012 06:57:48 +0100",
                        "content": "Comment1: Full Comment Text",
                        "username": "FacebookUser1",
                        "profileUrl": "http://www.facebook.com/profile.php?id=1"
                      },
                      {
                        "date": "Thu, 26 Jan 2012 07:03:24 +0100",
                        "content": "Comment2: Full Comment Text",
                        "username": "FacebookUser2",
                        "profileUrl": "http://www.facebook.com/profile.php?id=2"
                      },
                      {
                        "date": "Thu, 26 Jan 2012 07:03:41 +0100",
                        "content": "Comment3: Full Comment Text",
                        "username": "FacebookUser3",
                        "profileUrl": "http://www.facebook.com/profile.php?id=3"
                      },
                      {
                        "date": "Thu, 26 Jan 2012 07:11:44 +0100",
                        "content": "Comment4: Full Comment Text",
                        "username": "FacebookUser4",
                        "profileUrl": "http://www.facebook.com/profile.php?id=4"
                      }
                    ]
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

User Contributed Notes