Export user data
If you’d like a copy of your user profile data, you can download a JSON (JavaScript Object Notation) or CSV (comma-separated values) file from within the Console. The resulting CSV file (which can be opened in any spreadsheet program) will look similar to this:
givenName,familyName,email,primaryAddress.phone,birthday,created
Antonio,Carrera,antonio_c_carrera@aol.com,,1963-12-24,2017-09-25 15:23:14.387821
Bob,Jones,gmstemp@hotmail.com,425-555-1234,1967-07-12,2017-09-25 14:59:21.547807
Marie,Fuentes,greg.stemp@yahoo.com,,1960-10-18,2017-09-21 18:17:43.053899
Susan,Jackson,gmichaelstemp@gmail.com,,1989-12-19,2017-09-21 16:28:20.093839
Terrance,O'Reilly,terrance_oreilly@mail.com,,1990-07-05,2017-09-25 15:39:37.137609
So is there anything else you need to know when it comes to exporting user data.? Well, we can think of two things. First, export only returns values for the attributes currently shown in your Console search results. By default, the Console shows the following six attributes:
- First Name (givenName)
- Last Name (familyName)
- Email (email)
- Phone (primaryAddress.phone)
- Birthday (birthday)
- Created (created)
If you want to return values for other attributes (for example, a user’s city and state), then you need to modify the user profile display attributes shown in the Console search results.
Similarly, export only returns data for the user profiles currently shown in the search results. For example, suppose you search for all the users who live in Oregon, and only those users are displayed in the Console. If you then decide to export data, you’ll only get back information for users who live in Oregon. To get back information for all your users, highlight and delete the existing query in order to return the Console to the default display (all users).
Although, before you do that, see the caution at the end of this topic.
To export user profile data, complete the following procedure:
-
From either the Manage Profiles home page or the Advanced Search page, click the Export Options button:
-
From the Download File list, click either CSV or JSON, depending on the file format you prefer.
It’s that easy.
As a general rule, you’ll find it faster and easier to export data using the Console rather than the REST APIs. This is because the Console, unlike the APIs, requires no coding or development time. Instead, anyone – even non-developers – can conduct a search and export the results.
However, you should be cautious about exporting large datasets (for example, a dataset containing hundreds of thousands of records). We recommend that you consult with your Akamai representative before attempting to export a large dataset. And, before you ask, at this point in time there’s not a good rule of thumb for determining what constitutes a “large dataset.” That’s because the size of an export requires you to factor in such things as the number of records being exported, the number of attributes being exported, and the amount of data that might be contained in those attributes. Your best bet is to discuss data exports with your Akamai representative before you begin.
If you’d like a copy of your user profile data, you can download a JSON (JavaScript Object Notation) or CSV (comma-separated values) file from within the Console. The resulting CSV file (which can be opened in any spreadsheet program) will look similar to this:
givenName,familyName,email,primaryAddress.phone,birthday,created
Antonio,Carrera,antonio_c_carrera@aol.com,,1963-12-24,2017-09-25 15:23:14.387821
Bob,Jones,gmstemp@hotmail.com,425-555-1234,1967-07-12,2017-09-25 14:59:21.547807
Marie,Fuentes,greg.stemp@yahoo.com,,1960-10-18,2017-09-21 18:17:43.053899
Susan,Jackson,gmichaelstemp@gmail.com,,1989-12-19,2017-09-21 16:28:20.093839
Terrance,O'Reilly,terrance_oreilly@mail.com,,1990-07-05,2017-09-25 15:39:37.137609
So is there anything else you need to know when it comes to exporting user data.? Well, we can think of two things. First, export only returns values for the attributes currently shown in your Console search results. By default, the Console shows the following six attributes:
- First Name (givenName)
- Last Name (familyName)
- Email (email)
- Phone (primaryAddress.phone)
- Birthday (birthday)
- Created (created)
If you want to return values for other attributes (for example, a user’s city and state), then, again, you need to modify the user profile search display attributes shown in the Console search results.
Similarly, export only returns data for the user profiles currently shown in the search results. For example, suppose you search for all the users who live in Oregon, and only those users are displayed in the Console. If you then decide to export data, you’ll only get back information for users who live in Oregon. To get back information for all your users, highlight and delete the existing query in order to return the Console to the default display (all users).
Although, before you do that, see the caution at the end of this topic.
To export user profile data, complete the following procedure:
-
From either the Manage Profiles home page or the Advanced Search page, click the Export Options button:
-
From the Download File list, click either CSV or JSON, depending on the file format you prefer.
It’s that easy.
As a general rule, you’ll find it faster and easier to export data using the Console rather than the REST APIs. This is because the Console, unlike the APIs, requires no coding or development time. Instead, anyone – even non-developers – can conduct a search and export the results.
However, you should be cautious about exporting large datasets (for example, a dataset containing hundreds of thousands of records). We recommend that you consult with your Akamai representative before attempting to export a large dataset. And, before you ask, at this point in time there’s not a good rule of thumb for determining what constitutes a “large dataset.” That’s because the size of an export requires you to factor in such things as the number of records being exported, the number of attributes being exported, and the amount of data that might be contained in those attributes. Your best bet is to discuss data exports with your Akamai representative before you begin.
Updated over 2 years ago