[Dashboard API] Cannot filter events by Amplitude Event Name

Hi, everyone!

I’m trying to create api request for this conditions:

I’m using JS fetch method.

This request fails:

fetch('https://amplitude.com/api/2/events/segmentation?' + new URLSearchParams({<br />  e: '{"event_type":"_all","filters":[{"subprop_type":"event","subprop_key":"Event Name","subprop_op":"is","subprop_value":["Test"]}]}',<br />  m: 'uniques',<br />  start: '20210101',<br />  end: '20220101',<br />  i: 30<br />}).toString(), {<br />  method: 'GET',<br />  headers: {<br />    accept: '*/*',<br />    'Content-Type': 'application/json',<br />    Authorization: 'Basic API_KEY:SECRET_KEY'<br />  }<br />})

If I’m using custom user property, everything works.

fetch('https://amplitude.com/api/2/events/segmentation?' + new URLSearchParams({<br />  e: '{"event_type":"_all","filters":[{"subprop_type":"user","subprop_key":"gp:Is Tester","subprop_op":"is","subprop_value":["(none)"]}]}',<br />  m: 'uniques',<br />  start: '20210101',<br />  end: '20220101',<br />  i: 30<br />}).toString(), {<br />  method: 'GET',<br />  headers: {<br />    accept: '*/*',<br />    'Content-Type': 'application/json',<br />    Authorization: 'Basic API_KEY:SECRET_KEY'<br />  }<br />})

I have issue with Amplitude Event Name.

Thanks for any help!

Find more posts tagged with

Event Segmentation

API

Accepted answers

gapon2401

Hi, ning.chang! I need to exclude the list of events from the results. This is he main goal.

I see two options:

Long way: Use Export API and filter the data as I want.
Short way: Create charts with desired conditions and use query:
```
https://amplitude.com/api/3/chart/CHART_ID_HERE/query
```

Then, after the requests to several charts, I will combine the data as I need.

All comments

SheenaGreen

gapon2401 Are you receiving an error response with the failure? If so, what does it say?

gapon2401

I recieve HTTP 400: Bad Request

Saish Redkar

Hey gapon2401,

Afaik, “Event Name” is a UI based property by Amplitude and don’t think it can be used explicitly in API calls.

In the first call, it seems like you are trying to use “Event Name” as an event property by specifying its value as “Test”, whereas Test is actually your event name in itself.

If you are replicating the screenshot, a better way would be to directly use the event name “Test”

"event_type":"Test"

and then apply the relevant user property/ event property filters.

The second call works fine because you are querying “Any Event” ( _all ) where your user property

“Is Tester” = none

Let me know if this works for you.

gapon2401

Saish Redkar Thank you for your reply!

I need to filter events with operator “is” or “is not”. That’s why I tried to use amplitute property “Event name”.

Here is the screenshot of desired result:

So, I use “Any event” and “Event name” to combine the events I need. I don’t know, how to make it other way with API.

Saish Redkar

Hey gapon2401

That’s a fair use case.
I’m not sure if we can replicate that in the API call since I haven’t come across any parameter to use the “Event Name” property explicitly in the docs. Currently, the Dashboard REST API supports segmentation by up to two events only.

ning.chang

Hi gapon2401!

Saish Redkar is right in that this is currently not possible in the API call. Maybe you can elaborate a bit on the objective of what you’re trying to do, so we can help brainstorm other ways of achieving it?

gapon2401

Hi, ning.chang! I need to exclude the list of events from the results. This is he main goal.

I see two options:

Long way: Use Export API and filter the data as I want.
Short way: Create charts with desired conditions and use query:
```
https://amplitude.com/api/3/chart/CHART_ID_HERE/query
```

Then, after the requests to several charts, I will combine the data as I need.

ning.chang

Gotcha! I see these two options too. The second one seems cleaner to me, as you can exclude using the filters available within the platform UI to perform the queries you want.

gapon2401

Yes, I agree! Less work, using the power of platform.

Thanks everyone for the help!

Quick Links

Unanswered Questions

Auto Capture Configuration Option does not exist for the React Native SDK
Auto Capture is a very prominent feature for the Browser SDK and the Native SDK's i.e. the IOS and the Android SDKs. It allows us to capture the basic [Amplitude] events like Button clicks, Navigation to pages, Pages Viewed, etc. The project that I am currently working on already has a web version on which we use the…
Import data from one amplitude account to another
How do I transfer data from one amplitude account to another? It seems all the community chats about this have completely broken links. Easy to export, no way to import, very frustrating. :(
@amplitude/plugin-web-vitals-browser build fails on CRA v4 (react-scripts@4.0.3)
When using @amplitude/plugin-web-vitals-browser with Create React App v4 (react-scripts@4.0.3), the build fails with: ./node_modules/@amplitude/plugin-web-vitals-browser/node_modules/web-vitals/dist/web-vitals.js<br /><br />SyntaxError:…
Question about Amplitude Export API Data Delay
Hello, I'm using SpringBoot and Kotlin to integrate with the Amplitude Export API. The official Amplitude documentation (https://amplitude.com/docs/apis/analytics/export) states that "data is available to export at a minimum within 2 hours of when the servers received it." However, there's no clear information about the…
Retrieve via the API users based on a user property
Hello, Is there a way to make a query like: “Give me all the users that have the user property X equal to 10”, by using just any of the APIs, without making a cohort first through the Amplitude’s UI? Thank you!