Community Mentions Metrics

Rest API to fetch the community mentions metrics for a given chain

Description

This endpoint retrieves the community mentions on twitter of a specified blockchain for a given date range. It requires an API key for authentication and valid date range inputs.

Request

• Method: GET

• Headers:

  • X-API-Key: A valid API key for authentication.

• Body Parameters:

  • chain: The blockchain to query. This should be one of ETHEREUM, ARBITRUM, BSC, OPTIMISM, BASE or POLYGON

  • start_date: The start date for the query (YYYY-MM-DD format).

  • end_date: The end date for the query (YYYY-MM-DD format).

  • includes: Comma separated items containing reply, retweet, tweet and quote

Response

• Success: Returns a JSON array of objects with date (in YYYY-MM-DD format) and tweet metrics that have been queries

• Error: Returns an error message with an appropriate status code in case of invalid API key, missing parameters, or server issues.

Sample Request

{
  "chain": "ETHEREUM",
  "start_date": "2023-01-01",
  "end_date": "2023-01-07",
  "includes": "reply,retweet,quote,tweet"
}

Sample Response

{
'data': [
        {'date': '2023-01-28', 'quote': 406485, 'reply': 409896, 'retweet': 462400, 'tweet': 420109},
        {'date': '2023-01-31', 'quote': 451519, 'reply': 453300, 'retweet': 512241, 'tweet': 465051},
        ....]
}

Example

POST https://dashboard.withblaze.app/api/social-metrics/community-metions

Headers

Name	Type	Description
x-api-key*	API-KEY	Your Blaze API Key

Request Body

Name	Type	Description
chain*	Enum	One of the supported chains - ETHEREUM, ARBITRUM, BSC, OPTIMISM, BASE or POLYGON
start_date*	String	Start date for the queried metric
end_date*	String	End date for the queried metric
includes	String	Type of tweets to include. Comma separated items containing reply, retweet, tweet and quote

200: OK Successful response

[
  {"date": "2023-01-01", "active_users": 12000},
  {"date": "2023-01-02", "active_users": 12500},
  ...
]

400: Bad Request If required parameters are missing or incorrect

401: Unauthorized If the API key is missing

403: Forbidden If the API key is invalid