---
updatedAt: 2025-06-12T20:24:12.000Z
agentTools:
  projectIndex: https://developer.accelevents.com/llms.txt
---

# Get All Sponsor Click Analytics

* API used at host side event admin, super admin, and organizer admin can access this API.
* This API is used to get sponsor click analytics. Returning a list of sponsors present in the event with the count of how many times one sponsor gets clicked by attendees.
* We are not collecting admin and staff users' clicks if they click on any sponsor that will be not counted.
* We need to pass an authorization token here, which is generated after successful login into the account.

Here is the description of response attributes, which returns in the form of JSON.

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        Attribute
      </th>

      <th style={{ textAlign: "left" }}>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        **Records Total** 
      </td>

      <td style={{ textAlign: "left" }}>
        The total number of sponsors present in the event.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Records Filtered** 
      </td>

      <td style={{ textAlign: "left" }}>
        Count of filtered records based on specified pagination details and searchSearch.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Error** 
      </td>

      <td style={{ textAlign: "left" }}>
        Error message if getting any error while getting records.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Data**
      </td>

      <td style={{ textAlign: "left" }}>
        List of sponsors with their analytics information.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Id**
      </td>

      <td style={{ textAlign: "left" }}>
        Unique id of the sponsor.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Sponsor Name**
      </td>

      <td style={{ textAlign: "left" }}>
        Name of the sponsor.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Count By Source**
      </td>

      <td style={{ textAlign: "left" }}>
        How many times the sponsor gets clicks from different sources.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Event Site**
      </td>

      <td style={{ textAlign: "left" }}>
        Count of how many times the sponsor gets clicks from the event site or landing page of the event.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Total**
      </td>

      <td style={{ textAlign: "left" }}>
        Count of the total number of time the sponsor get clicks by attendees.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **Virtual Event Hub**
      </td>

      <td style={{ textAlign: "left" }}>
        Count of how many times the sponsor gets clicks inside virtual event hub possible sources are sponsor tab on lobby page, the section above chat, etc.
      </td>
    </tr>
  </tbody>
</Table>

Description of HTTP Response code.

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Response Code
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        200
      </td>

      <td>
        Successfully API called.
      </td>
    </tr>

    <tr>
      <td>
        400
      </td>

      <td>
        The request could not be understood by the server due to malformed syntax.
      </td>
    </tr>

    <tr>
      <td>
        401
      </td>

      <td>
        You are not authorized to view the resource.
      </td>
    </tr>

    <tr>
      <td>
        4030201
      </td>

      <td>
        You don't have host-level access to access the resource
      </td>
    </tr>
  </tbody>
</Table>

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "accelevents",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.accelevents.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/rest/host/event/{eventUrl}/sponsors/analytics": {
      "get": {
        "summary": "Get All Sponsor Click Analytics",
        "description": "* API used at host side event admin, super admin, and organizer admin can access this API.\n* This API is used to get sponsor click analytics. Returning a list of sponsors present in the event with the count of how many times one sponsor gets clicked by attendees.\n* We are not collecting admin and staff users' clicks if they click on any sponsor that will be not counted.\n* We need to pass an authorization token here, which is generated after successful login into the account.",
        "operationId": "get-all-sponsor-click-analytics",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "description": "Pages are zero indexed, thus providing 0 for page will return the first page.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "Size will returns number of records when call api default will returns 10 records.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 10
            }
          },
          {
            "name": "searchString",
            "in": "query",
            "description": "Filter sponsors by their name specifying `searchString`.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "authorization",
            "in": "header",
            "description": "API authentication token.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "eventUrl",
            "in": "path",
            "description": "Event url is unique identifier for your event. E.g https://www.accelevents.com/events/demo. Here demo is the event url.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\"recordsTotal\":3,\"recordsFiltered\":3,\"data\":[{\"id\":1247,\"sponsorName\":\"s3\",\"countBySource\":{\"total\":2586,\"event_site\":1010,\"virtual_event_hub\":1576}},{\"id\":1246,\"sponsorName\":\"sp2\",\"countBySource\":{\"total\":1544,\"event_site\":1006,\"virtual_event_hub\":538}},{\"id\":1245,\"sponsorName\":\"sp1\",\"countBySource\":{\"total\":2102,\"event_site\":510,\"virtual_event_hub\":1592}}],\"error\":null}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "recordsTotal": {
                      "type": "integer",
                      "example": 3,
                      "default": 0
                    },
                    "recordsFiltered": {
                      "type": "integer",
                      "example": 3,
                      "default": 0
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "integer",
                            "example": 1247,
                            "default": 0
                          },
                          "sponsorName": {
                            "type": "string",
                            "example": "s3"
                          },
                          "countBySource": {
                            "type": "object",
                            "properties": {
                              "total": {
                                "type": "integer",
                                "example": 2586,
                                "default": 0
                              },
                              "event_site": {
                                "type": "integer",
                                "example": 1010,
                                "default": 0
                              },
                              "virtual_event_hub": {
                                "type": "integer",
                                "example": 1576,
                                "default": 0
                              }
                            }
                          }
                        }
                      }
                    },
                    "error": {}
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": "You are not authorized to view the resource."
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": "Not authorized"
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```