--- updatedAt: 2025-06-04T21:28:37.000Z agentTools: projectIndex: https://developer.simpplr.com/llms.txt --- # Site Popularity Use this API to get popular sites # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "simpplr-api-gateway", "version": "1.0" }, "servers": [ { "url": "https://api.ec.simpplr.com/api" } ], "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": {} } } }, "security": [ { "sec0": [] } ], "paths": { "/analytics/site-popularity": { "get": { "summary": "Site Popularity", "description": "Use this API to get popular sites", "operationId": "site-popularity", "parameters": [ { "name": "x-user-email", "in": "header", "description": "User's email to login into Salesforce", "required": true, "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Time from which the News Letters data need to be selected", "required": true, "schema": { "type": "string", "default": "2020-12-27" } }, { "name": "to", "in": "query", "description": "Time till which the News Letters data need to be selected", "required": true, "schema": { "type": "string", "default": "2022-01-26" } }, { "name": "group-by", "in": "query", "description": "Group the Result according to group-by value", "schema": { "type": "string", "enum": [ "day", "week", "month" ], "default": "day" } }, { "name": "order-by", "in": "query", "description": "Order by which result need to be selected", "required": true, "schema": { "type": "string", "enum": [ "top", "bottom" ], "default": "top" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": \"success\",\n \"result\": {\n \"data\": {\n \"sites\": [\n {\n \"views\": 414,\n \"value\": 221725,\n \"url\": \"https://hotaka-stg-one--simpplr.visualforce.com/apex/simpplr__app?u=/site/a1G5f000004FCitEAG/feed\",\n \"shares\": 0,\n \"replies\": 4,\n \"posts\": 8690,\n \"likes\": 17,\n \"label\": \"Manager site\",\n \"id\": \"a1G5f000004FCitEAG\",\n \"favorites\": 4,\n \"access\": \"private\"\n },\n {\n \"views\": 1059,\n \"value\": 12310,\n \"url\": \"https://hotaka-stg-one--simpplr.visualforce.com/apex/simpplr__app?u=/site/a1G5f000004FCApEAO/dashboard\",\n \"shares\": 0,\n \"replies\": 1,\n \"posts\": 65,\n \"likes\": 5,\n \"label\": \"Test Site 123\",\n \"id\": \"a1G5f000004FCApEAO\",\n \"favorites\": 3,\n \"access\": \"public\"\n },\n {\n \"views\": 774,\n \"value\": 9670,\n \"url\": \"https://hotaka-stg-one--simpplr.visualforce.com/apex/simpplr__app?u=/site/a1G5f000004FCLdEAO/dashboard\",\n \"shares\": 0,\n \"replies\": 9,\n \"posts\": 61,\n \"likes\": 15,\n \"label\": \"Test Google Drive\",\n \"id\": \"a1G5f000004FCLdEAO\",\n \"favorites\": 12,\n \"access\": \"private\"\n },\n {\n \"views\": 696,\n \"value\": 8350,\n \"url\": \"https://hotaka-stg-one--simpplr.visualforce.com/apex/simpplr__app?u=/site/a1G5f000004FCftEAG/dashboard\",\n \"shares\": 0,\n \"replies\": 2,\n \"posts\": 42,\n \"likes\": 20,\n \"label\": \"Analytics Public Site\",\n \"id\": \"a1G5f000004FCftEAG\",\n \"favorites\": 16,\n \"access\": \"public\"\n },\n {\n \"views\": 520,\n \"value\": 6640,\n \"url\": \"https://hotaka-stg-one--simpplr.visualforce.com/apex/simpplr__app?u=/site/a1G5f000004Fa9WEAS/dashboard\",\n \"shares\": 0,\n \"replies\": 1,\n \"posts\": 52,\n \"likes\": 8,\n \"label\": \"royal rumble\",\n \"id\": \"a1G5f000004Fa9WEAS\",\n \"favorites\": 5,\n \"access\": \"public\"\n },\n {\n \"views\": 495,\n \"value\": 5765,\n \"url\": \"https://hotaka-stg-one--simpplr.visualforce.com/apex/simpplr__app?u=/site/a1G5f000004FDC4EAO/dashboard\",\n \"shares\": 0,\n \"replies\": 3,\n \"posts\": 29,\n \"likes\": 2,\n \"label\": \"Diksha's Pub Siteas\",\n \"id\": \"a1G5f000004FDC4EAO\",\n \"favorites\": 0,\n \"access\": \"public\"\n },\n {\n \"views\": 320,\n \"value\": 4090,\n \"url\": \"https://hotaka-stg-one--simpplr.visualforce.com/apex/simpplr__app?u=/site/a1G5f000004FrtIEAS/dashboard\",\n \"shares\": 0,\n \"replies\": 1,\n \"posts\": 33,\n \"likes\": 3,\n \"label\": \"RD Feb 21\",\n \"id\": \"a1G5f000004FrtIEAS\",\n \"favorites\": 0,\n \"access\": \"public\"\n },\n {\n \"views\": 363,\n \"value\": 4005,\n \"url\": \"https://hotaka-stg-one--simpplr.visualforce.com/apex/simpplr__app?u=/site/a1G5f000004FCg3EAG/dashboard\",\n \"shares\": 0,\n \"replies\": 0,\n \"posts\": 12,\n \"likes\": 5,\n \"label\": \"Test Site CC\",\n \"id\": \"a1G5f000004FCg3EAG\",\n \"favorites\": 5,\n \"access\": \"private\"\n },\n {\n \"views\": 277,\n \"value\": 3445,\n \"url\": \"https://hotaka-stg-one--simpplr.visualforce.com/apex/simpplr__app?u=/site/a1G5f000004TRNLEA4/dashboard\",\n \"shares\": 0,\n \"replies\": 0,\n \"posts\": 27,\n \"likes\": 0,\n \"label\": \"Test Site Admin Owner\",\n \"id\": \"a1G5f000004TRNLEA4\",\n \"favorites\": 0,\n \"access\": \"public\"\n },\n {\n \"views\": 228,\n \"value\": 2670,\n \"url\": \"https://hotaka-stg-one--simpplr.visualforce.com/apex/simpplr__app?u=/site/a1G5f000004Fry3EAC/dashboard\",\n \"shares\": 0,\n \"replies\": 0,\n \"posts\": 15,\n \"likes\": 1,\n \"label\": \"Test feb21\",\n \"id\": \"a1G5f000004Fry3EAC\",\n \"favorites\": 2,\n \"access\": \"public\"\n }\n ]\n },\n \"csvUrl\": \"https://hotaka-stg-one--simpplr.visualforce.com/apex/simpplr__Reports?action=getSitePopularity&to=2022-03-27&from=2021-02-25&orderBy=top\"\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "success" }, "result": { "type": "object", "properties": { "data": { "type": "object", "properties": { "sites": { "type": "array", "items": { "type": "object", "properties": { "views": { "type": "integer", "example": 414, "default": 0 }, "value": { "type": "integer", "example": 221725, "default": 0 }, "url": { "type": "string", "example": "https://hotaka-stg-one--simpplr.visualforce.com/apex/simpplr__app?u=/site/a1G5f000004FCitEAG/feed" }, "shares": { "type": "integer", "example": 0, "default": 0 }, "replies": { "type": "integer", "example": 4, "default": 0 }, "posts": { "type": "integer", "example": 8690, "default": 0 }, "likes": { "type": "integer", "example": 17, "default": 0 }, "label": { "type": "string", "example": "Manager site" }, "id": { "type": "string", "example": "a1G5f000004FCitEAG" }, "favorites": { "type": "integer", "example": 4, "default": 0 }, "access": { "type": "string", "example": "private" } } } } } }, "csvUrl": { "type": "string", "example": "https://hotaka-stg-one--simpplr.visualforce.com/apex/simpplr__Reports?action=getSitePopularity&to=2022-03-27&from=2021-02-25&orderBy=top" } } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"statusCode\": 401,\n \"status\": \"error\",\n \"message\": \"SESSION_TIMEOUT\",\n \"data\": {}\n}" } }, "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 401, "default": 0 }, "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "SESSION_TIMEOUT" }, "data": { "type": "object", "properties": {} } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```