StatSocial

StatSocial Platform API

API Reference: The StatSocial API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to…

Social#openapi#social#marketing

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

API Reference: The StatSocial API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients, and we support cross-origin resource sharing to allow you to interact securely with our API from a client-side web application (remember that you should never expose your secret API key in any public website's client-side code). JSON will be returned in all responses from the API, including errors (though if you're using API bindings, we will convert the response to the appropriate language-specific object). Contact help@statsocial.com to obtain a test API key

Endpoints 17

Application

  • GETUsed to understand API usage/applications/status/?key=stringRemaining window and remaining count details, also returns reports that have been generated by this account.

Reports

  • GETObtain report output/reports/?report_hash=string&baseline=0&report_date=0&sample=1Output is ordered by Demographic and followed by Affinity information. For each data point the following metrics are provided value, count, mean, percentile,…
  • POSTObtain report output/reports/?report_hash=string&baseline=0&report_date=0&sample=1Output is ordered by Demographic and followed by Affinity information. For each data point the following metrics are provided value, count, mean, percentile,…
  • GETGet report dates available for a specific report/reports/dates/?report_hash=stringGet report dates available for a specific report.
  • POSTGet report dates available for a specific report/reports/dates/?report_hash=stringGet report dates available for a specific report.
  • GETGet list of generated reports/reports/status/?report_hash=stringReturns a list of custom reports generated by user (report name to upload hash etc).
  • POSTGet list of generated reports/reports/status/?report_hash=stringReturns a list of custom reports generated by user (report name to upload hash etc).

Custom Reports

  • GETStep 3 of executing custom report/reports/custom/create/?upload_hash=string&filter=stringUsed to create a custom report. This report treats the list of ids or handles as the audience (not their followers as in the twitter report). To create…
  • POSTStep 3 of executing custom report/reports/custom/create/?upload_hash=string&filter=stringUsed to create a custom report. This report treats the list of ids or handles as the audience (not their followers as in the twitter report). To create…
  • GETStep 1 of executing custom report/reports/custom/generate/?report_name=stringUsed to create a custom report. This report treats the list of ids or handles as the audience (not their followers as in the twitter report). To create…
  • POSTStep 1 of executing custom report/reports/custom/generate/?report_name=stringUsed to create a custom report. This report treats the list of ids or handles as the audience (not their followers as in the twitter report). To create…
  • GETStep 2 of executing custom report/reports/custom/insert/?upload_hash=string&ids=Inserting twitter ids or handles into a custom report. This is used for custom reports only
  • POSTStep 2 of executing custom report/reports/custom/insert/?upload_hash=string&ids=Inserting twitter ids or handles into a custom report. This is used for custom reports only

Tweet Reports

  • GETUsed to create tweet reports/reports/tweet/create/?report_name=string&start_date=0&end_date=0&terms=string&filter=stringThis report details the audience of the users who have tweeted content that matches what was provided in the keywords. To create custom or twitter reports…
  • POSTUsed to create tweet reports/reports/tweet/create/?report_name=string&start_date=0&end_date=0&terms=string&filter=stringThis report details the audience of the users who have tweeted content that matches what was provided in the keywords. To create custom or twitter reports…

Follower Reports

  • GETUsed to create twitter follower report/reports/twitter/create/?twitter_id=0&twitter_handle=string&filter=stringThis report uses the twitter followers as the audience. To create custom or tweet reports other methods must be used. Any report older than two days will be…
  • POSTUsed to create twitter follower report/reports/twitter/create/?twitter_id=0&twitter_handle=string&filter=stringThis report uses the twitter followers as the audience. To create custom or tweet reports other methods must be used. Any report older than two days will be…

API details

Base URL
http://api.statsocial.com/api
Authentication
An API key in the api_key header
Operations
17 operations on 9 pathsGET 9POST 8
Main resources
Custom Reports 6Reports 6Follower Reports 2Tweet Reports 2Application 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the StatSocial Platform API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the StatSocial Platform API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the api_key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Used to understand API usage” (GET /applications/status/?key=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the StatSocial Platform API?

API Reference: The StatSocial API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to… It is listed under Social and has 17 endpoints.

Who publishes the StatSocial Platform API?

It is listed from StatSocial's public API description (an OpenAPI document), not published by StatSocial on Swastik Codes. Anyone who controls statsocial.com can claim the profile by adding a DNS TXT record.

What is the base URL of the StatSocial Platform API?

Requests go to http://api.statsocial.com/api. Endpoint paths are added to this base URL.

How do I authenticate with the StatSocial Platform API?

With an API key in the api_key header.

How many endpoints does the StatSocial Platform API have?

17 operations on 9 paths (9 GET, 8 POST). The largest groups are Custom Reports, Reports, Follower Reports, Tweet Reports.

Is forking the StatSocial Platform API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.